The following tables list the attributes you can use when customizing your print templates, including:

Following each is an example in JSON of using the attributes to build a print template.

Pack Slip

Attributes

DataJSON Field NameDescription
Packslip IDpackSlipIdPack Slip Identifier
SellerClosed A seller is part of an organization. It can represent a sales channel, geographic region, or line of business. Organizations can have more than one seller, but a seller can have only one organization. IDstoreIdSeller Code; for example, TMSUS
Node IDClosed A unique name that identifies a specific node.nodeIdFulfillment NodeClosed A fulfillment location; that is, a DC, store, or dropship vendor. Also called Inventory Node. (Fulfillment Location) ID
Order SourceorderSourceIdentifies where the order was originated; for example, US_MPCAEBAY
HFR EligiblehfrEligibleIdentifies whether a fulfillment order/shipment is eligible for Hassle Free Return
Fulfillment OrderClosed An order that is ready to be picked, packed, shipped, and/or picked up. InformationfulfillmentOrderIdFulfillment Order/Shipment General Information
Fulfillment Order IDfulfillmentOrderIdFulfillment Order Number
WebOrder IDwebOrderIdWebstore Order Number
OMS Order IDomsOrderIdOMS Order Number
External Order NumberExternalOrderNumberMarketplace/Retail Connection Order Number; for example, Amazon, eBay, and so on
External Order Number2ExternalOrderNumber2Secondary External Order Number
Customer IDcustomerIdCustomer ID assigned by the system that is taking the order (for example, 123456789- alphanumeric)
Fulfillment TypefulfillmentTypeFulfillment Type (for example, SHIP_TO_STOREClosed A fulfillment type that means Ship To Store., STORE_PICK_UPClosed A fulfillment type that means In-Store Pickup., SHIP_TO_HOMEClosed A fulfillment type that means Ship From Store.)
CurrencyCurrencyType of Currency used for the order (for example, "USD")
CarriercarrierCarrier SCAC ; for example, ANY
Service LevelserviceCarrier Service Code; for example, 2DAY
Fulfillment Order DatefulfillmentOrderDateFulfillment Order Create Date
Order DateorderDateWeborder/Marketplaceorder/Retail Connection order create date
StatusstatusFulfillment order status
Packagespackages 
Package IDpackageIdPackage ID
Package ItemspackageItemsItems included in the package. For each item:
webline IDwebLineIdWeborder/Marketplaceorder/Retail Connection order Line ID
Item IDitemIdRadial Item ID
QuantityquantityItem Packed Quantity
Package HeightheightPackage Height
Unit of MeasureunitHeight Unit of Measure; for example, cm
ValuevalueHeight Value
Package WidthwidthPackage Width
Unit of MeasureunitWidth Unit of Measure; for example, cm
ValuevalueWidth Value
Package LengthlengthPackage Length
Unit of MeasureunitLength Unit of Measure; for example, cm
ValuevalueLength Value
Package WeightweightPackage Total Weight(includes items weight, package weight and paking material weight)
Unit of MeasureunitWeight Unit of Measure; for example, LBS
ValuevalueWeight Value
Fulfillment Order Items fulfillmentOrderItems

Items included in the fulfillment order. Provides details for each item included in the fulfillment order

IDidLine Item ID
webline IDwebLineIdWeborder Line ID
Is CustomizedisCustomizedIdentifies if an item is customized
Item Details:itemDetailsItem detail information
Item IDitemIdRadial Item ID: Catalog ID + Client Item ID; for example, "21-MB01-NA"
   
Item DescriptionitemDescItem Description
ColorcolorColor Description
Color CodecolorCodeColor Code
SizesizeSize Description
Size CodesizeCodeSize Code
StylestyleStyle ID
Item HierarchyproductLineItem hierarchy: DepartmentNumber.SubDepartmentNumber.ClassNumber.SubclassNumber
Item TypeClosed A category that describes the item; for example, regular merchandise, gift card, or gift wrap.itemTypeItem Type; for example, regulat merchandise, gift wrap, etc.
Item WeightweightItem weight
Unit of MeasureunitWeight Unit of Measure; for example, LBS
ValuevalueWeight Value
UPCSupcsUPCs
UPC TypetypeUPC Type; for example, UPC-G
UPC NumbervalueUPC Number
BarcodebarcodeUPC barcode
All Item Master Extended and Custom AttributesadditionalAttributesAll Item Master Extended and Custom Attributes that are used by a client; for example, FreightClass, PackageType, HFR_ELIGIBLE, etc. (Print Document API - "additionalAttributes")
Attribute NamenameCustom attribute name; for example, FreightClass
Attribute ValuevalueCustom attribute value; for example, ANYG
All Order Line Item Custom AttributecustomAttributesAll Order Line Item Attributes that are used by a client; for example, variation attributes such as color and size. (Print Document API - "custom Attributes")
Attribute NamekeyAttribute name
Attribute ValuevalueAttribute value
Ordered QuantityorderedQuantityOrdered Quantity
Item Total:itemTotalToal price of an order line item
Unit PriceunitPriceItem Unit Price
Extented PriceextendedPriceItem Total Price befoe discount (Print Document API: "extendedPrice in itemTotal)
ChargeschargesLine Item Charges total amount (this amoount includes discounts, shippingand any other charges listed as chargeGroups in the API
TaxtaxTotal Tax Amount for the line item
Item Total After DiscounttotalAmountAfterDiscountItem Total Price after discount (Print Document API: "totalAmountAfterDiscount" in itemTotal)
List of all line item chargeschargeGroupsA list of all order charges; for example, "MerchandiseDiscount", "Shipping", etc. (Print Document API: "chargeGroups").
NamenameCharge Group Name, e.g MerchandiseDiscount
Total AmounttotalAmountCharge Group Total
Referenced ChargesreferencedChargesCharges that are referenced in the charge group
NamenameReference ID; for example, Promotion ID
Unit PriceunitPriceA charge amount per single item. If a charge is unit-based, then a unit price will be provided
Line PricelinePriceA charge amount per order line. If a charge is line-based, then a line price will be provided
Charge AmountamountTotal Charge Amount
InstructionsinstructionsVarious Item related Instructions such as Gift Message, packing instructions,etc.
TypetypeInstruction type; for example, Gift
TexttextInstruction text; for example, "Happy Birthday!"
Hazmat InticatorhazmatIndicatorIndicates if an items is considered hazardous material
DestinationsdestinationsFulfillment Order Address information
Destination IDdestinationIdA unique destination id within an order; for example, billing_1, shipping_1
Destination TypedestinationTypeDestination type; for example, MAILING_ADDRESS, SHIPPING_ADDRESS
Person NamepersonNameCustomer or Ship-to Person name
First NamefirstNameCustomer / Ship-to Person First Name
Last NamelastNameCustomer / Ship-to Person Last Name
Phone NumberphoneCustomer Phone Number
EmailemailCustomer / Ship-to Person Email Address
Addressaddress 
Address Line1line1Address Line 1
Address Line 2line2Address Line 2
Address Line 3line3Address Line 3
Address Line 4line4Address Line 4
CitycityCity
State / ProvincemainDivisionCodeState / Province
Postal CodepostalCodePostal code
Country CodecountryCodeISO Country Code
Billing AddressbillToAddressBilling address
Destination IDdestinationIdBilling address Destination ID
Shipping AddressshippingAddressShip to address
Destination IDdestinationIdShipping address Destination ID
Order TotalorderTotalOrder Totals
Grand TotalgrandTotalFulfillment Order Total Amount
Merchandise TotallineSubTotalMerchandise Subtotal (before discount)
Total Tax AmountgrandTaxTotal Tax Amount
Total ChargesgrandChargesCharges grand total
Header TaxhdrTaxHeader Tax Amount
Header ChargeshdrChargesHeader level charges
Cash on DeliverycashOnDeliveryCash on Delivery Amount when applicable
CurrencycurrencyType of Currency used for the order (e.g. "USD")
Shipping and Handling TotalsshippingAndHandlingTotalsShipping and Handling Totals will list vaious charges included in the Charges Grand Total. This includes Total Merchandise Discount, Total Shipping Discount and Shipping and Handling Total before discount
Charge NamechargeNameCharge Name; for example,Shipping, MerchandiseDiscount, ShippingDiscount
Total AmounttotalAmountTotal Charge Amount
PaymentspaymentsPayment information
Payment TypetypePayment type; for example, "CC"
Tender TypetenderTypeTender type; for example, "VS"
Display NumberdisplayNoThe Account Number displayed on the screen; for example, last 4 digits of the CC #
Ship DateshipDateFulfillment Order Ship Date

JSON Example

Copy

{

{
    "packSlipDetails": [{
        "packSlipId": "527152628",
        "storeId": "TMSUS",
        "nodeId": "TMS_NA-Store1",
        "orderSource": "EB2C",
        "hfrEligible": true,
        "carrierException": true,
        "fulfillmentOrder": {
            "fulfillmentOrderId": "100055696554001",
            "webOrderId": "0002624128080453",
            "omsOrderId": "100055696554",
            "fulfillmentType": "SHIP_TO_HOME",
            "carrier": "ANY",
            "service": "2DAY",
            "fulfillmentOrderDate": "2019-06-04T20:16:27+00:00",
            "orderDate": "2019-04-12T16:58:00+00:00",
            "status": "1100.70.06.50",
            "packages": [{
                "packageId": "100150506",
                "weight": {
                    "unit": "LBS",
                    "value": 4.6
                },
                "length": {
                    "unit": "in",
                    "value": 30.0
                },
                "height": {
                    "unit": "in",
                    "value": 40.0
                },
                "width": {
                    "unit": "in",
                    "value": 20.0
                },
                "packageItems": [{
                    "itemId": "21-RITSFSTest01",
                    "webLineId": "1",
                    "quantity": 4
                }]
            }],
            "fulfillmentOrderItems": [{
                "id": "1",
                "webLineId": "1",
                "isCustomized": false,
                "itemDetails": {
                    "itemId": "21-RITSFSTest01",
                    "itemDesc": "Black Tennis Shoes",
                    "color": "Brown",
                    "colorCode": "700",
                    "size": "6-M",
                    "sizeCode": "6-M",
                    "style": "789",
                    "productLine": "992.998.1.1",
                    "itemType": "MERCH",
                    "weight": {
                        "unit": "LBS",
                        "value": 1.15
                    },
                    "upcs": [{
                        "type": "UPC-A",
                        "value": "1234567890"
                    }, {
                        "type": "UPC-A",
                        "value": "1234567891"
                    }, {
                        "type": "UPC-A",
                        "value": "1234567892"
                    }],
                    "additionalAttributes": [{
                        "name": "FreightClass",
                        "value": "ANYG"
                    }, {
                        "name": "StyleID",
                        "value": "789"
                    }, {
                        "name": "PackageType",
                        "value": "Poly Bag"
                    }, {
                        "name": "HFR_ELIGIBLE",
                        "value": "false"
                    }, {
                        "name": "Shipping_Optimization_Eligible",
                        "value": "false"
                    }]
                },
                "orderedQuantity": 4,
                "itemTotal": {
                    "unitPrice": 114.0,
                    "extendedPrice": 456.0,
                    "charges": -109.0,
                    "tax": 10.55,
                    "totalAmountAfterDiscount": 357.55
                },
                "chargeGroups": [{
                    "name": "MerchandiseDiscount",
                    "totalAmount": 114.0,
                    "referencedCharges": [{
                        "name": "XsQKMcArp8MAAAFK7dYIDApN",
                        "isDiscount": false,
                        "informational": false,
                        "unitPrice": 28.5,
                        "linePrice": 0.0,
                        "amount": 114.0
                    }]
                }, {
                    "name": "Shipping",
                    "totalAmount": 5.0,
                    "referencedCharges": [{
                        "isDiscount": false,
                        "informational": false,
                        "unitPrice": 0.0,
                        "linePrice": 5.0,
                        "amount": 5.0
                    }]
                }],
                "customAttributes": [{
                    "key": "PVAR_CODE_COLOR",
                    "value": "700"
                }, {
                    "key": "PVAR_DESC_COLOR",
                    "value": "Brown"
                }, {
                    "key": "PVAR_LABEL_COLOR",
                    "value": "color"
                }, {
                    "key": "PVAR_CODE_SIZE",
                    "value": "6-M"
                }, {
                    "key": "PVAR_DESC_SIZE",
                    "value": "6-M"
                }, {
                    "key": "PVAR_LABEL_SIZE",
                    "value": "Size"
                }]
            }],
            "destinations": [{
                "destinationId": "billing_1",
                "destinationType": "MAILING_ADDRESS",
                "personName": {
                    "firstName": "Ankur",
                    "lastName": "Patel"
                },
                "phone": "6102223333",
                "address": {
                    "line1": "1000 San Leandro Blvd",
                    "city": "San Leandro",
                    "mainDivisionCode": "CA",
                    "postalCode": "14577",
                    "countryCode": "US"
                },
                "email": "RIT_E2E_237_SFS@dashboard.gsi"
            }, {
                "destinationId": "shipping_1",
                "destinationType": "SHIPPING_ADDRESS",
                "personName": {
                    "firstName": "Ankur",
                    "lastName": "Patel"
                },
                "phone": "6102223333",
                "address": {
                    "line1": "1000 San Leandro Blvd",
                    "city": "San Leandro",
                    "mainDivisionCode": "CA",
                    "postalCode": "14577",
                    "countryCode": "US"
                }
            }],
            "billToAddress": {
                "destinationId": "billing_1"
            },
            "shippingAddress": {
                "destinationId": "shipping_1"
            },
            "orderTotal": {
                "grandTotal": 357.55,
                "lineSubTotal": 456.0,
                "grandTax": 10.55,
                "grandCharges": 5.0,
                "hdrTax": 0.0,
                "hdrCharges": 0.0
            },
            "payments": [{
                "type": "CC",
                "tenderType": "AF",
                "displayNo": "1111"
            }],
            "currency": "USD",
            "customerId": "null9039781784",
            "shippingAndHandlingTotals": [{
                "chargeName": "Shipping",
                "totalAmount": 5.0
            }, {
                "chargeName": "MerchandiseDiscount",
                "totalAmount": -114.0
            }]
        },
        "shipDate": "2019-06-04T20:17:01"
    }]
}

Pick Ticket

Attributes

DataJSON Field NamesDescription
Pick TicketClosed A document that specifies the items in an order. The Store Associate uses the pick ticket to assemble the order. IDpickTicketIdA unique pick ticket id
Seller IDstoreIdSeller Code; for example, TMSUS
NodeClosed A fulfillment location. Can be a distribution center, dropshipper, or retail store. IDnodeIdFulfillment Node (Fulfillment Location) Id
Queue IdqueueIdWaiting to Pick Queue ID
User IDuserIdUser ID assigned to a pick ticket
StatusstatusPick Ticket Status; for example, New, INPROGRESS, etc.
Pick Ticket TypepickTicketTypePick Ticket Type: PICK_TICKET
Fulfillment TypefulfillmentTypeFulfillment Type; for example, SHIP_TO_STORE, STORE_PICK_UP, etc.
Pick Ticket DatepickTicketDatePick Ticket Create Date
Pick SLAClosed Service Level Agreement. DatepickSLADateThe date / time the pick ticket should be confirmed based on the configured SLAs
Total Fulfillment OrderstotalFulfillmentOrdersTotal number of fuflfillment orders included in the pick ticket
CurrencycurrencyCurrency
Total SKUstotalSKUsTotal number of SKUs included in the ticket
Total QuantitytotalQuantityTotal Quantityof items included in the ticket
Pick Ticket ItemspickTicketItemsFor each item included in the pick ticket, the following data is provided:
IDidPick Ticket Line ID
Item DetailsitemDetailsItem Details
Client IDclientIdClient ID; for example, TMSNA
Item IDitemIdRadial Item ID: Catalog ID + Client Item ID,e.g. "21-MB01-NA"
Client Item IDclientItemIdClient Item ID; for example, "MB01-NA"
Catalog IDcatalogIdRadial Catalog ID; for example, 21
GIIgiiGlobal Item Identifier assigned by OMS at item creation
Item TypetypeItem Type; for example, MERCH ( source - Item Master)
Item StatusstatusItem status: Active / Inactive ( source - Item Master)
Product TitleproductTitleProduct title displayed on the webstore product page
Item DescriptiondescriptionItem descriptionprovided in the Item Master
ImagesimagesItem images ( source - Item Master). For each image the below info is provided:
urlurlImage url
typetypeImage type; for example, "prod_main"
viewviewImage view; for example, "main"
heightheightImage height
widthwidthImage width
Freight ClassClosed A classification of freight as defined by the National Motor Freight Traffic Association (NMFTA). A shipment’s freight class determines the carrier’s shipping charges.freightClassFreight Class
Sales ClassClosed Indicates whether an item can be backordered against future inventory.salesClassSales Class; for example, stock
Tax CodetaxCodeTax code
HierarchyhierarchyMerchandise hierarchy
DepartmentdeptNumberDepartment
SubdepartmentsubDeptNumberSubdepartment number
Subdepartment DescriptionsubDeptDescriptionSubdepartment Description
ClassclassNumberClass
Class DescriptionclassDescriptionClass Description
SubclasssubClassNumberSubclass
Subclass DescriptionsubClassDescriptionSubclass Description
Display Mass DimensionsdisplayMassDimensionsDisplay Mass Dimansions (source - Item Master) -item weight used for shipping label generation
Unit of MeasureunitFor example, kg
weightweightItem weight
Display Packaging DimensionsdisplayPackagingDimensionsDisplay Packing Dimensions (source - Item Master)
Unit of MeasureunitFor example, cm
widthwidthItem width
lengthlengthItem length
heightheightitem height
Style IDstyleIdItem Style ID ( source - Item Master)
SizessizesSize information (source - Item Master)
SizeCodecodeSize Code
SizeDescriptiondescriptionSize description
ColorcolorColor Description(source - Item Master)
Brandbrand 
Brand NamenameBrand Name; for example, Prio
Brand DescriptiondescriptionBrand description
ManufacturermanufacturerManufacturer Name
Manufacturer NamenameManufacturer Description
Manufacturer IDidManufacturer ID
Fulfillment Type EligibilitiesfulfillmentTypeEligibilitiesEligibilities for fulfillment type (source - Item Master)
Fulfillment Type IDfulfillmentTypeIdSHIP_TO_HOME, SHIP_TO_STORE or STORE_PICK_UP
EligibilityeligibilityEligibility flag - value: true or false
sfsEligible flagsfsEligibleSpecifies if an item is eligible for Ship from Store (source - Item Master)
ispuEligible flagispuEligibleSpecifies if an item is eligible for Store Pickup (source - Item Master)
STSEligible flagstsEligibleSpecifies if an item is eligible for Ship to Store (source - Item Master)
AssociateDeliveryEligible flagassociateDeliveryEligibleSpecified if an item is eligibile for associate delivery
dropshipped flagdropShippedSpecifies if an item can be fulfilled using a drop shipper (source - Item Master)
onPreOrder flagonPreOrderSpecifies if an item is on pre-order (source - Item Master)
bundle flagbundleSpecifies if an item has infinite inventory (source - Item Master)
infinite Inventory flaginfiniteInventoryAllows to set infinite inventory for an item (source - Item Master). It's used for such items as warranties, gift cards, etc.
eligible to modify flageligibleToModifyUsed for Order Modify - specifies if Item QTY can be modified or the item can be added to the existing order (source - Item Master)
Min. Shipment Processing DaysminShipmentProcessingDaysMinimum number of days before an item can be shipped (source - Item Master)
Max. Shipment Procssing DaysmaxShipmentProcessingDaysMaximum number of days before an item can be shipped (Source - Item Master)
Item DescriptionitemDescItem Descriptionprovided in the customer order
ColorcolorColor Description(source - Customer Order)
Color CodecolorCodeColor Code(source - Customer Order)
SizesizesSize Description (source - Customer Order)
Size CodesizeCodeSize Code (source - Customer Order)
StylestyleStyle ID (source - Customer Order)
UPCSupcsUPCs
UPC TypetypeUPC Type; for example, UPC-G
UPC NumbervalueUPC Number
BarcodebarcodeUPC barcode
All Item Master Extended and Custom Attributes All Item Master Extended and Custom Attributes that are used by a client will be provided; for example, FreightClass, PackageType, HFR_ELIGIBLE, etc.
Additional AttributesadditionalAttributeItem Master Extended and Custom Attributes that are used by a client will be provided; for example, FreightClass, PackageType, HFR_ELIGIBLE, etc.Note: These attributes are mapped to the named fields in the order
Attribute NamenameAttribute Name; for example, FreightClass, PackageType, HFR_ELIGIBLE, etc.
ValuevalueAttribute Value; for example, ANYG, Poly Bag, etc.
Custom Dynamic attributescustomDynamicAttributesItem custom attributes - source: item master. Note: These attributes are mapped to the name / value pairs, i.e. order line custom attributes
Attribute NamenameCustom attribute name
Attribute ValuevalueCustome attribute value
QuantityquantityItem Ordered QTY
Unit PriceunitPriceItem Unit Price
Retail PriceretailPriceRetail Store Item Price
Pick LocationpickLocationIn-store Inventory Location
Picked QuantitypickedQuantityItem Picked Quantity
Canceled QuantitycanceledQuantityItem Canceled Quantity
Canceled Reason CodecancellationReasonCodeCanceled Reason Code
Pick Ticket ID BarcodepickTicketIdBarcodePick Ticket IDbarcode

JSON Example

Copy
{
    "packSlipDetails": [{
        "packSlipId": "527152628",
        "storeId": "TMSUS",
        "nodeId": "TMS_NA-Store1",
        "orderSource": "EB2C",
        "hfrEligible": true,
        "carrierException": true,
        "fulfillmentOrder": {
            "fulfillmentOrderId": "100055696554001",
            "webOrderId": "0002624128080453",
            "omsOrderId": "100055696554",
            "fulfillmentType": "SHIP_TO_HOME",
            "carrier": "ANY",
            "service": "2DAY",
            "fulfillmentOrderDate": "2019-06-04T20:16:27+00:00",
            "orderDate": "2019-04-12T16:58:00+00:00",
            "status": "1100.70.06.50",
            "packages": [{
                "packageId": "100150506",
                "weight": {
                    "unit": "LBS",
                    "value": 4.6
                },
                "length": {
                    "unit": "in",
                    "value": 30.0
                },
                "height": {
                    "unit": "in",
                    "value": 40.0
                },
                "width": {
                    "unit": "in",
                    "value": 20.0
                },
                "packageItems": [{
                    "itemId": "21-RITSFSTest01",
                    "webLineId": "1",
                    "quantity": 4
                }]
            }],
            "fulfillmentOrderItems": [{
                "id": "1",
                "webLineId": "1",
                "isCustomized": false,
                "itemDetails": {
                    "itemId": "21-RITSFSTest01",
                    "itemDesc": "Black Tennis Shoes",
                    "color": "Brown",
                    "colorCode": "700",
                    "size": "6-M",
                    "sizeCode": "6-M",
                    "style": "789",
                    "productLine": "992.998.1.1",
                    "itemType": "MERCH",
                    "weight": {
                        "unit": "LBS",
                        "value": 1.15
                    },
                    "upcs": [{
                        "type": "UPC-A",
                        "value": "1234567890"
                    }, {
                        "type": "UPC-A",
                        "value": "1234567891"
                    }, {
                        "type": "UPC-A",
                        "value": "1234567892"
                    }],
                    "additionalAttributes": [{
                        "name": "FreightClass",
                        "value": "ANYG"
                    }, {
                        "name": "StyleID",
                        "value": "789"
                    }, {
                        "name": "PackageType",
                        "value": "Poly Bag"
                    }, {
                        "name": "HFR_ELIGIBLE",
                        "value": "false"
                    }, {
                        "name": "Shipping_Optimization_Eligible",
                        "value": "false"
                    }]
                },
                "orderedQuantity": 4,
                "itemTotal": {
                    "unitPrice": 114.0,
                    "extendedPrice": 456.0,
                    "charges": -109.0,
                    "tax": 10.55,
                    "totalAmountAfterDiscount": 357.55
                },
                "chargeGroups": [{
                    "name": "MerchandiseDiscount",
                    "totalAmount": 114.0,
                    "referencedCharges": [{
                        "name": "XsQKMcArp8MAAAFK7dYIDApN",
                        "isDiscount": false,
                        "informational": false,
                        "unitPrice": 28.5,
                        "linePrice": 0.0,
                        "amount": 114.0
                    }]
                }, {
                    "name": "Shipping",
                    "totalAmount": 5.0,
                    "referencedCharges": [{
                        "isDiscount": false,
                        "informational": false,
                        "unitPrice": 0.0,
                        "linePrice": 5.0,
                        "amount": 5.0
                    }]
                }],
                "customAttributes": [{
                    "key": "PVAR_CODE_COLOR",
                    "value": "700"
                }, {
                    "key": "PVAR_DESC_COLOR",
                    "value": "Brown"
                }, {
                    "key": "PVAR_LABEL_COLOR",
                    "value": "color"
                }, {
                    "key": "PVAR_CODE_SIZE",
                    "value": "6-M"
                }, {
                    "key": "PVAR_DESC_SIZE",
                    "value": "6-M"
                }, {
                    "key": "PVAR_LABEL_SIZE",
                    "value": "Size"
                }]
            }],
            "destinations": [{
                "destinationId": "billing_1",
                "destinationType": "MAILING_ADDRESS",
                "personName": {
                    "firstName": "Ankur",
                    "lastName": "Patel"
                },
                "phone": "6102223333",
                "address": {
                    "line1": "1000 San Leandro Blvd",
                    "city": "San Leandro",
                    "mainDivisionCode": "CA",
                    "postalCode": "14577",
                    "countryCode": "US"
                },
                "email": "RIT_E2E_237_SFS@dashboard.gsi"
            }, {
                "destinationId": "shipping_1",
                "destinationType": "SHIPPING_ADDRESS",
                "personName": {
                    "firstName": "Ankur",
                    "lastName": "Patel"
                },
                "phone": "6102223333",
                "address": {
                    "line1": "1000 San Leandro Blvd",
                    "city": "San Leandro",
                    "mainDivisionCode": "CA",
                    "postalCode": "14577",
                    "countryCode": "US"
                }
            }],
            "billToAddress": {
                "destinationId": "billing_1"
            },
            "shippingAddress": {
                "destinationId": "shipping_1"
            },
            "orderTotal": {
                "grandTotal": 357.55,
                "lineSubTotal": 456.0,
                "grandTax": 10.55,
                "grandCharges": 5.0,
                "hdrTax": 0.0,
                "hdrCharges": 0.0
            },
            "payments": [{
                "type": "CC",
                "tenderType": "AF",
                "displayNo": "1111"
            }],
            "currency": "USD",
            "customerId": "null9039781784",
            "shippingAndHandlingTotals": [{
                "chargeName": "Shipping",
                "totalAmount": 5.0
            }, {
                "chargeName": "MerchandiseDiscount",
                "totalAmount": -114.0
            }]
        },
        "shipDate": "2019-06-04T20:17:01"
    }]
}

Customer Receipt

Attributes

DataJSON Field NamesDescription
Customer Receipt IDcustomerReceiptIdA unique customer receipt id
Fulfillment Order IDfulfillmentOrderIdFulfillment Order Number
WebOrder IDwebOrderIdWebstore Order Number
OMS Order IDomsOrderIdOMS Order Number
OMS Order ID Barcodes

omsOrderIdBarcode128A

omsOrderIdBarcode128B

omsOrderIdBarcode39

OMS Order Number barcodes
Web Order ID Barcodes

webOrderIdBarcode128A

webOrderIdBarcode128B

webOrderIdBarcode39

Web Order ID barcodes
Order DateorderDateOrder Create Date
Seller IDstoreIdSeller Code; for example, TMSUS
Node IDnodeIdPickup Node ID
Fulfillment TypefulfillmentTypeFulfillment Type; for example, STORE_PICK_UP, etc.
CurrencycurrencyCurrency
Total Amount Breakdown:totalAmountBreakDown 
MerchadisemerchandiseMerchandise subtotal
ChargeschargesTotal charges amount
DiscountdiscountsTotal discount amount
TaxestaxesTotal tax amount
TotaltotalFulfillment order total amount
Customer Pickup ItemscustomerPickUpItemsItems that are ready for customer pickup. For each item, the following datais provided:
Webline IDwebLineIdWeborder line id
ididUnique Item ID within an order - the same value as weborder line id
Item IDitemIdRadial Item ID
Item DescriptionitemDescItem Description
ColorcolorColor Description
Color CodecolorCodeColor Code
SizesizeSize Description
Size CodesizeCodeSize Code
StylestyleStyle ID
Ordered QuantityorderedQuantityOrdered Quantity
Picked QuantitypickedQuantityBackroom Pick - quantity picked
Backroom Pick Cancel QuantitypickCanceledQuantityBackroom Pick - quantity declined
Customer Canceled QuantitycustomerPickCanceledQuantityCustomer refused / not picked up quantity
Customer Canceled ReasoncustomerPickCancelReasonCodeCustomer pickup cancel reason code
Customer Picked QuantitycustomerPickedQuantityCustomer picked up quantity
Proxy Pickup Address ReferenceproxyPickupAddressProxy Pickup Address reference
UPCSupcsUPCs
UPC TypetypeUPC Type; for example, UPC-G
UPC NumbervalueUPC Number
UPC Barcode

upcBarcodeCode128A

upcBarcodeCode128B

upcBarcodeCode39

UPC barcodes
Item Total Amoount BreakdowntotalItemBreakDown 
Unit PriceunitPriceItem Unit Price; for example, "unitPrice" : 114.0
Merchandise AmountmerchandiseItem total price before discount
DiscountsdiscountsItem discount amount
ChargeschargesItem total charges
TaxestaxesItem total tax amount
Item TotaltotalItem Total Amount
All Item Master Extended and Custom AttributesitemAdditionalAttributesAll Item Master Extended and Custom Attributes that are used by a client will be provided; for example, FreightClass, HazmatClass, PackageType, etc. (Print Document API - "itemAdditionalAttributes")
Attribute NamenameAttribute name; for example, FreightClass
Attribute ValuevalueAttribute value; for example, ANYG
All order line item custom attributescustomAttributesAll Order Line Item Attributes that are used by a client; for example, variation attributes such as color and size. (Print Document API - "custom Attributes")
Attribute NamekeyAttribute name; for example, PVAR_CODE_COLOR
Attribute ValuevalueAttrbute value; for example, 700
List of all line item chargeschargeGroupse.g. "Gift Wrap", "Shipping", etc. (Print Document API: "chargeGroups")
NamenameCharge Group Name, e.g MerchandiseDiscount
Total AmounttotalAmountCharge Group Total
Referenced ChargesreferencedChargesCharges that are referenced in the charge group
NamenameReference ID; for example, Promotion ID
Is Discount flagisDiscountIdentifies if a charge is discount
InformationalinformationalIdentifies if a charge is informational
Unit PriceunitPriceA charge amount per single item. If a charge is unit-based, then a unit price will be provided
Line PricelinePriceA charge amount per order line. If a charge is line-based, then a line price will be provided
Charge AmountamountTotal Charge Amount
PaymentspaymentsPayment information
Credit Card Expiration DatecreditCardExpDateCredit card expiration date
Payment TypepaymentTypeTender type; for example, "CC"
Credit Card NamecreditCardNameName on the credit card
Credit Card TypecreditCardTypeCredit Card Type; for example, "MC"
Credit Card NumbercreditCardNoCredit card number
Proxy Pickup DetailsproxyPickupDetailsProxy Pickup Information
Address IDidAddress ID that us used as a reference (see proxyPickupAddress)
Proxy NamepersonNameProxy person name
First NamefirstNameProxy person first name
Last NamelastNameProxy person last name
Proxy Person AddressaddressProxy person mailing address
Address Line 1line1Address line 1
Address Line 2line2Address line 2
Address Line 3line3Address line 3
Address Line 4line4Address line 4
CitycityCity
State / ProvincemainDivisionCodeState / province
Postal CodepostalCodePostal code
Country CodecountryCodeISO country code
RelationshiprelationshipProxy person relationship to the customer; for example, "Brother"
Proxy EmailemailProxy person email address
Proxy PhonephoneProxy person Phone Number
DestinationsdestinationsFulfillment order address iformation
Destination IDdestinationIdA unique destination id within an order; for example, billing_1 or shipFrom
Destination TypedestinationTypeDestination type; for example, MAILING_ADDRESS or NODE_ADDRESS
Person NamepersonNameCustomer name
First NamefirstNameCustomer First Name
Last NamelastNameCustomer Last Name
Phone NumberphoneCustomer Phone Number
EmailemailCustomer Email Address
AddressaddressAddress details
Address Line1line1Address Line 1
Address Line 2line2Address Line 2
Address Line 3line3Address Line 3
Address Line 4line4Address Line 4
CitycityCity
State / ProvincemainDivisionCodeState / Province
Postal CodepostalCodePostal code
Country CodecountryCodeISO Country Code
Billing AddressbillToAddressBiilling Address
Billing Address Destination IDdestinationIdBilling address destination id; for example, billing_1
Customer IDcustomerIdCustomer ID assigned by the system that is taking the order
ReturnsreturnsReturn order information - a dummy return will be created for items refused by a customer if a customer payment menthod was charged at pick ticket confirmation
Return Order IDreturnOrderIdReturn order number
Total Amount Breakdown:totalAmountBreakDownTotal Return Order amount breakdown
MerchandisemerchandiseTotal return merchandise amount before discount
ChargeschargesTotal return order charges
DiscountdiscountsTotal return order discount amount
TaxestaxesTotal return order tax amount
Return TotaltotalReturn order total amount
Return Order Items:orderItemsItems included in the return order. For each item, the following information is provided:
Webline IDwebLineIdWeborder line id
IdidUnique Item ID within an order - the same value as weborder line id
Item IDitemIdRadial Item ID
Item DescriptionitemDescItem Description
Return QuantityquantityItem Return (not picked up) quantity
Total Item Breakdown:totalItemBreakDownReturn item total breakdown
MerchandisemerchandiseItem total price before discount
ChargeschargesItem total charges
DiscountdiscountsItem discount amount
TaxestaxesItem total tax amount
TotaltotalItem total amount

JSON Examples

Proxy Person and Attributes

Copy
{
  "customerReceiptId": "100015930",
  "customerPickUpDetails": {
    "fulfillmentOrderId": "100052171624001",
    "webOrderId": "000261712081312RO",
    "omsOrderId": "100052171624",
    "orderDate": "2017-09-11T03:50:52+00:00",
    "storeId": "TMSUS",
    "nodeId": "TMS_NA-Store1",
    "fulfillmentType": "STORE_PICK_UP",
    "currency": "USD",
    "totalAmountBreakDown": {
      "merchandise": 114,
      "charges": 0,
      "discounts": 0,
      "taxes": 6.84,
      "total": 120.84
    },
    "customerPickUpItems": [{
      "webLineId": "1",
      "id": "1",
      "itemId": "21-ISPUProd01",
      "itemDesc": "Black Tennis Shoes",
      "color" : "Hazel",
      "colorCode" : "300",
      "size" : "Size 6 - Medium",
      "sizeCode" : "6-M",
      "style" : "789",
      "orderedQuantity": 1,
      "canceledQuantity": 1,
      "customerPickedQuantity": 0,
      "upcs": [{
        "type": "P",
        "value": "355470307",
        "upcBarcodeCode128A": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANEAAAB4AQAAAABEUipkAAAAZElEQVR4nGP6jxM0MDHgBsNf7sytHtP0o31zxI0zz8ZImeum9c42V885rzXY3DkqNyo3KjcqNyo3KjcqNyo3KjcqR46ciVrJ6ZnWRSkvz043XvLs5OVZxaknb04xvDbY3ElfOQA7FTNXjVbBIAAAAABJRU5ErkJggg==",
        "upcBarcodeCode128B": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANEAAAB4AQAAAABEUipkAAAAZElEQVR4nGP6jxM0MDHgBsNf7kxVj2n60b454saZZ2OkzHXTemebGwv7aw02d47KjcqNyo3KjcqNyo3KjcqNyo3KkSNn0lZyeqZ1UcrLs9ONlzw7eXlWcerJs283Xhts7qSvHABeIjNXT8QBmAAAAABJRU5ErkJggg==",
        "upcBarcodeCode39": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOMAAAB4AQAAAAAoVHhhAAAAaUlEQVR4nGP6jwc8YGLAB0ae7G3vWcHZa5duXqOl52UWoh09ber0pdtUr0XpeDUMWjePyo7KjsqOyo7KjsqOyo7KjsqOyo40WdWtaWunBkf7hly7tO3UmqtLs7Izo71uay27sm203Y4KALK3OLXNkFADAAAAAElFTkSuQmCC"
      }],
      "totalItemBreakDown": {
        "merchandise": 114,
        "charges": 0,
        "discounts": 0,
        "taxes": 6.84,
        "total": 120.84
      }
    },
    {
      "webLineId": "2",
      "id": "2",
      "itemId": "21-ISPUProd02",
      "itemDesc": "Blue Tennis Shoes",
      "color" : "Hazel",
      "colorCode" : "300",
      "size" : "5",
      "sizeCode" : "6-M",
      "style" : "355470308",
      "orderedQuantity": 2,
      "canceledQuantity": 0,
      "customerPickedQuantity": 2,
      "upcs": [{
        "type": "P",
        "value": "355470307",
        "upcBarcodeCode128A": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANEAAAB4AQAAAABEUipkAAAAZElEQVR4nGP6jxM0MDHgBsNf7sytHtP0o31zxI0zz8ZImeum9c42V885rzXY3DkqNyo3KjcqNyo3KjcqNyo3KjcqR46ciVrJ6ZnWRSkvz043XvLs5OVZxaknb04xvDbY3ElfOQA7FTNXjVbBIAAAAABJRU5ErkJggg==",
        "upcBarcodeCode128B": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAANEAAAB4AQAAAABEUipkAAAAZElEQVR4nGP6jxM0MDHgBsNf7kxVj2n60b454saZZ2OkzHXTemebGwv7aw02d47KjcqNyo3KjcqNyo3KjcqNyo3KkSNn0lZyeqZ1UcrLs9ONlzw7eXlWcerJs283Xhts7qSvHABeIjNXT8QBmAAAAABJRU5ErkJggg==",
        "upcBarcodeCode39": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOMAAAB4AQAAAAAoVHhhAAAAaUlEQVR4nGP6jwc8YGLAB0ae7G3vWcHZa5duXqOl52UWoh09ber0pdtUr0XpeDUMWjePyo7KjsqOyo7KjsqOyo7KjsqOyo40WdWtaWunBkf7hly7tO3UmqtLs7Izo71uay27sm203Y4KALK3OLXNkFADAAAAAElFTkSuQmCC"
      }],
      "totalItemBreakDown": {
        "merchandise": 114,
        "charges": 0,
        "discounts": 0,
        "taxes": 6.84,
        "total": 120.84
      }
    }],
    "payments": [{
      "creditCardExpDate": "2020-12",
      "paymentType": "CC",
      "creditCardName": "HerbBrooks",
      "creditCardType": "VS",
      "creditCardNo": "1111"
    }],
    "proxyPickupDetails" : {
      "id" : "proxyPickupAddress_1",
      "personName" : {
        "firstName" : "Damian",
        "lastName" : "Cregar"
      },
      "relationship": "Brother",
      "email" : "cregard@radial.com",
      "phone" : "6107419440"
    },
    "destinations": [{
      "destinationId": "billing_1",
      "destinationType": "MAILING_ADDRESS",
      "personName": {
        "firstName": "Herb",
        "lastName": "Brooks"
      },
      "phone": "1111111111",
      "address": {
        "line1": "801 Hat Trick Avenue",
        "city": "Eveleth",
        "mainDivisionCode": "MN",
        "countryCode": "US"
      },
      "email": "RIT_E2E_240_LogPro@dashboard.gsi"
    }, {
       "destinationId":"shipFrom",
       "destinationType":"NODE_ADDRESS",
       "address":{
          "line1":"175 W Valley Forge Rd",
          "city":"king of Prussia",
          "mainDivisionCode":"PA",
          "countryCode":"US",
          "postalCode":"19406"
       }
    }],
    "billToAddress": {
      "destinationId": "billing_1"
    }
  },
  "returns": [{
    "returnOrderId": "100052171634",
    "totalAmountBreakDown": {
      "merchandise": 114,
      "charges": 0,
      "discounts": 0,
      "taxes": 6.84,
      "total": 120.84
    },
    "orderItems": [{
      "webLineId": "1",
      "id": "1",
      "itemId": "21-ISPUProd01",
      "itemDesc": "Black Tennis Shoes",
      "quantity": 1,
      "totalItemBreakDown": {
        "merchandise": 114,
        "charges": 0,
        "discounts": 0,
        "taxes": 6.84,
        "total": 120.84
      }
    }]
  }],
  "omsOrderIdBarcode128A": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALsAAAB4AQAAAACCl77dAAAAW0lEQVR4nGP6jx08YGLAAYaPxJk7Usm5fl2TNpvr3jw5yWiJ781JIt0NA+2qUYlRiVGJUYlRiVGJUYlRiVEJfBImKs/mTt5Ulud78rK6ed65mM3qeW9KR0AbDgChEi66Dyp1FAAAAABJRU5ErkJggg==",
  "omsOrderIdBarcode128B": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKUAAAB4AQAAAAC78A+GAAAAVElEQVR4nGP6jwX8YGLABoae6JmqvuRcv65Nk5Zn3jy5RTr17OMFg8Rlo6KjoqOio6KjoqOio6IjTdSkrWju5E1lfnmR09XNfZ7ONpZNGCQuo1QUADwxKNWj2l1jAAAAAElFTkSuQmCC",
  "omsOrderIdBarcode39": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMkAAAB4AQAAAABwK+t4AAAAYUlEQVR4nGP6jws0MDHgBMNX6rZ39LTJa6elLpumuzrLa3X05KvTl6XpqQ0iF45KjUqNSo1KjUqNSo1KjUqNSg1XKdWtS7Nyg7NmR2VdDp22LXRprnZm1KxLtwaRC+knBQCo6zFY5Rp+VQAAAABJRU5ErkJggg==",
  "9omsOrderIdBardcode128A": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJoAAAB4AQAAAAAiCNYzAAAAT0lEQVR4nGP6jwkOMDFgAUNH8MwdqeRcv65Jm811b56cVLhCdOCdNCo4KjgqOCo4KjgqOCo4CAVNVJ7NnbypLM/35GV187z+iNcD7ySKBAFL0iWe8BdjRAAAAABJRU5ErkJggg==",
  "webOrderIdBarcode128A": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALsAAAB4AQAAAACCl77dAAAAW0lEQVR4nGP6jx08YGLAAYaPxJk7Usm5fl2TNpvr3jw5yWiJ781JIt0NA+2qUYlRiVGJUYlRiVGJUYlRiVEJfBImKs/mTt5Ulud78rK6ed65mM3qeW9KR0AbDgChEi66Dyp1FAAAAABJRU5ErkJggg==",
  "webOrderIdBarcode128B": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOcAAAB4AQAAAAAhv9gbAAAAa0lEQVR4nGP6jwf8Y2LAB0ae7JkakeRc3+MztyTr3pwlo5LrmzVHXH3evdNfLFcMWjePyo7KjsqOyo7KjsqOyo7KjsqOyo40WZOWN3Mnb7ZM95l7WT3tyZ3Jm6elvLyZpGTKczxi0Lp5YGQBtHA403M9FawAAAAASUVORK5CYII=",
  "webOrderIdBarcode39": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAP0AAAB4AQAAAAARM8k6AAAAeUlEQVR4nGP6jx/8YGIgAEYVwBTc9t4cNnntNDOtaVFeWeHeUcGn104zXaMVpT3bK/tywiBx5KiCUQWjCkYVjCoYVTCqYFTBqIJRBaMKRhUQqUB1q++q3OCsU9eylm2btnLrsrWmwVmnQ64tu5q6barugkHiyCGgAACJGD7K7LLpmQAAAABJRU5ErkJggg=="
}

Shipping Charges and Charge Group

Copy
{
   "customerPickUpReceipt" : {
      "customerReceiptId" : "527152246",
      "customerPickUpDetails" : {
         "fulfillmentOrderId" : "100055694874001",
         "omsOrderId" : "100055694874",
         "orderDate" : "2019-06-03T15:34:42+00:00",
         "storeId" : "TMSUS",
         "nodeId" : "TMS_NA-Store3",
         "webOrderId" : "0002613821906953",
         "fulfillmentType" : "SHIP_TO_STORE",
         "totalAmountBreakDown" : {
            "merchandise" : 1026.0,
            "charges" : 0.0,
            "discounts" : 0.0,
            "taxes" : 20.24,
            "total" : 1046.24
         },
         "customerPickUpItems" : [ {
            "webLineId" : "1",
            "id" : "1",
            "itemId" : "21-ManGenSts01a",
            "itemDesc" : "Black Bag",
            "color" : "Hazel",
            "colorCode" : "300",
            "size" : "Size 6 - Medium",
            "sizeCode" : "6-M",
            "style" : "789",
            "orderedQuantity" : 4,
            "pickedQuantity" : 4,
            "pickCanceledQuantity" : 0,
            "customerPickCanceledQuantity" : 0,
            "customerPickedQuantity" : 4,
            "proxyPickupAddress" : "proxyPickupAddress_1",
            "upcs" : [ {
               "type" : "G",
               "value" : "036000123234"
            }, {
               "type" : "EAN",
               "value" : "305213091006"
            }, {
               "type" : "UPC-A",
               "value" : "036004523234"
            }, {
               "type" : "UPC-A",
               "value" : "305213123006"
            } ],
            "totalItemBreakDown" : {
               "merchandise" : 456.0,
               "charges" : 0.0,
               "discounts" : 0.0,
               "taxes" : 10.12,
               "total" : 466.12,
               "unitPrice" : 114.0
            },
            "itemAdditionalAttributes" : [ {
               "name" : "FreightClass",
               "value" : "ANYG"
            }, {
               "name" : "StyleID",
               "value" : "789"
            }, {
               "name" : "HazmatClass",
               "value" : "0"
            }, {
               "name" : "HFR_ELIGIBLE",
               "value" : "true"
            }, {
               "name" : "PackageType",
               "value" : "PolyBag"
            } ],
            "customAttributes" : [ {
               "key" : "PVAR_CODE_COLOR",
               "value" : "700"
            }, {
               "key" : "PVAR_DESC_COLOR",
               "value" : "Generic Color"
            }, {
               "key" : "PVAR_LABEL_COLOR",
               "value" : "color"
            }, {
               "key" : "PVAR_CODE_SIZE",
               "value" : "6-M"
            }, {
               "key" : "PVAR_DESC_SIZE",
               "value" : "6-M"
            }, {
               "key" : "PVAR_LABEL_SIZE",
               "value" : "Size"
            }, {
               "key" : "PIN_NUMBER",
               "value" : "08907965710028814457"
            } ]
         }, {
            "webLineId" : "2",
            "id" : "2",
            "itemId" : "21-ManGenSts01b",
            "itemDesc" : "Duffle Bag",
            "color" : "Hazel",
            "colorCode" : "300",
            "size" : "Size 6 - Medium",
            "sizeCode" : "6-M",
            "style" : "789",
            "orderedQuantity" : 5,
            "pickedQuantity" : 5,
            "pickCanceledQuantity" : 0,
            "customerPickCanceledQuantity" : 0,
            "customerPickedQuantity" : 5,
            "proxyPickupAddress" : "proxyPickupAddress_1",
            "upcs" : [ {
               "type" : "D",
               "value" : "036000123234"
            }, {
               "type" : "D",
               "value" : "305213091006"
            }, {
               "type" : "G",
               "value" : "036000123234"
            }, {
               "type" : "EAN",
               "value" : "305213091006"
            }, {
               "type" : "UPC",
               "value" : "036000123234"
            }, {
               "type" : "UPC-A",
               "value" : "036000123234"
            }, {
               "type" : "UPC-A",
               "value" : "305213091006"
            } ],
            "totalItemBreakDown" : {
               "merchandise" : 570.0,
               "charges" : 0.0,
               "discounts" : 0.0,
               "taxes" : 10.12,
               "total" : 580.12,
               "unitPrice" : 114.0
            },
            "itemAdditionalAttributes" : [ {
               "name" : "HazmatClass",
               "value" : "0"
            }, {
               "name" : "FreightClass",
               "value" : "ANYG"
            }, {
               "name" : "StyleID",
               "value" : "789"
            }, {
               "name" : "HFR_ELIGIBLE",
               "value" : "true"
            } ],
            "customAttributes" : [ {
               "key" : "PVAR_CODE_COLOR",
               "value" : "700"
            }, {
               "key" : "PVAR_DESC_COLOR",
               "value" : "Generic Color"
            }, {
               "key" : "PVAR_LABEL_COLOR",
               "value" : "color"
            }, {
               "key" : "PVAR_CODE_SIZE",
               "value" : "6-M"
            }, {
               "key" : "PVAR_DESC_SIZE",
               "value" : "6-M"
            }, {
               "key" : "PVAR_LABEL_SIZE",
               "value" : "Size"
            }, {
               "key" : "PIN_NUMBER",
               "value" : "08907965710028814457"
            } ]
         } ],
         "payments" : [ {
            "creditCardExpDate" : "2020-12",
            "paymentType" : "CC",
            "creditCardName" : "RichardDoyle",
            "creditCardType" : "VS",
            "creditCardNo" : "411111vjOiXS1111"
         } ],
         "proxyPickupDetails" : {
            "id" : "proxyPickupAddress_1",
            "personName" : {
               "firstName" : "Mary",
               "lastName" : "Pickup"
            },
            "phone" : "5551231234",
            "address" : {
               "line1" : "200 Adams Rd",
               "city" : "Harleysville",
               "mainDivisionCode" : "PA",
               "postalCode" : "19438",
               "countryCode" : "US"
            }
         },
         "destinations" : [ {
            "destinationId" : "billing_1",
            "destinationType" : "MAILING_ADDRESS",
            "personName" : {
               "firstName" : "Richard",
               "lastName" : "Doyle"
            },
            "phone" : "1111111111",
            "address" : {
               "line1" : "801 Hat Trick Avenue",
               "city" : "Eveleth",
               "mainDivisionCode" : "MN",
               "postalCode" : "55734",
               "countryCode" : "US"
            },
            "email" : "RadialNRFCustomer1@gmail.com"
         } ],
         "billToAddress" : {
            "destinationId" : "billing_1"
         },
         "customerId" : "null7668746471"
      },
      "returns" : [ {
         "returnOrderId" : "100055690864",
         "totalAmountBreakDown" : {
            "merchandise" : 342.0,
            "charges" : 0.0,
            "discounts" : 0.0,
            "taxes" : 0.0,
            "total" : 342.0
         },
         "orderItems" : [ {
            "webLineId" : "1",
            "id" : "1",
            "itemId" : "21-ManGenSts01b",
            "itemDesc" : "Duffle Bag",
            "quantity" : 3,
            "totalItemBreakDown" : {
               "merchandise" : 342.0,
               "charges" : 0.0,
               "discounts" : 0.0,
               "taxes" : 0.0,
               "total" : 342.0
            }
         } ]
      }, {
         "returnOrderId" : "100055690854",
         "totalAmountBreakDown" : {
            "merchandise" : 228.0,
            "charges" : 0.0,
            "discounts" : 0.0,
            "taxes" : 0.0,
            "total" : 228.0
         },
         "orderItems" : [ {
            "webLineId" : "1",
            "id" : "1",
            "itemId" : "21-ManGenSts01a",
            "itemDesc" : "Black Bag",
            "quantity" : 2,
            "totalItemBreakDown" : {
               "merchandise" : 228.0,
               "charges" : 0.0,
               "discounts" : 0.0,
               "taxes" : 0.0,
               "total" : 228.0
            }
         } ]
      } ]
   }
}

Hold Ticket

Attributes

DataJSON Field NamesDescription
Hold Ticket IDholdTicketIdA unique hold ticket document id
Fulfillment Order InformationfulfillmentOrderFulfillment Order information
Fulfillment Ordr IDfulfillmentOrderIdFulfillment Order Number
Seller IDstoreIdSeller Code; for example, TMSUS
Node IDnodeIdFulfillment Node (Fulfillment Location) Id
OMS Order IDomsOrderIdOMS Order Number
Fulfillment TypefulfillmentTypeFulfillment Type; for example, STORE_PICK_UP, etc.
CarriercarrierCarrier SCAC ; for example, ISPUClosed In-Store Pickup.
Service LevelserviceCarrier Service Code; for example, ISPU
Fulfillment Order DatefulfillmentOrderDateFulfillment Order Create Date
Order DateorderDateWeborder / Marketplaceorder / Retail Connection order create date
Total VolumetotalVolumeTotal volume of products
Unit of MeasureunitVolume Unit of Measure, e.g CIN (cubic inch)
ValuevalueTotal volume
Total WeighttotalWeightTotal weight of products
Unit of MeasureunitWeight Unit of Measure; for example, LBS
ValuevalueTotal weight
Pick Ticket IDpickTicketIdPick Ticket ID - this is a pick ticket that was used to complete a pick process for the fulfillment order
Hold Location IDholdLocationHold location for the order
Store Location NamestoreNameRetail store name
PIN NumberpinNumberPIN Number that was generated for the order. PIN Number is used to confirm customer identity
Fulfillment Order ItemsfulfillmentOrderItemsItems included in the fulfillment order. Provides detail information for each item included in the fulfillment order
ItemDetailsitemDetailsItem detail information
Item IDitemIdRadial Item ID
Item DescriptionitemDescItem Description
ColorcolorColor description
Color CodecolorCodeColor code
SizesizeSize description
Size CodesizeCodeSize code
StylestyleStyle ID
UPCSupcsUPCs
UPC TypetypeUPC Type; for example, UPC-G
UPC NumbervalueUPC Number
Ordered QuantityorderedQuantityItem ordered quantity
Ready for Pickup QuantityquantityItem Ready for Pickup quantity
Hold QuantityholdQuantityItem quantity at hold location
Canceled QuantitycanceledQuantityItem canceled quantity
Cancellation Reason CodecancellationReasonCodeCancellation Reason Code
Item TotalitemTotal 
Unit PriceunitPriceItem unit price
Extented PriceextendedPriceItem Total Price before discount
ChargeschargesTotal charges for the item
TaxtaxTotal tax amount for the item
Proxy Pickup InformationproxyPickupDetailsProxy Pickup detail information
Address IDidProxy person address id
Person NamepersonNameProxy person name
First NamefirstNameProxy first name
Last NamelastNameProxy last name
Proxy EmailemailProxy person email address
Proxy PhonephoneProxy person Phone Number
Proxy AddressaddressProxy person address
Address Line1line1Address Line 1
Address Line 2line2Address Line 2
Address Line 3line3Address Line 3
Address Line 4line4Address Line 4
CitycityCity
State / ProvincemainDivisionCodeState / Province
Postal CodepostalCodePostal code
Country CodecountryCodeISO Country Code
RelationshiprelationshipProxy person relationship to the customer; for example, "Brother"
DestinationsdestinationsFulfillment order address iformation
Destination IDdestinationIdA unique destination id within an order; for example, billing_1
Destination TypedestinationTypeDestination type; for example, MAILING_ADDRESS
Person NamepersonNameCustomer name
First NamefirstNameCustomer First Name
Last NamelastNameCustomer Last Name
Phone NumberphoneCustomer Phone Number
EmailemailCustomer Email Address
AddressaddressAddress details
Address Line1line1Address Line 1
Address Line 2line2Address Line 2
Address Line 3line3Address Line 3
Address Line 4line4Address Line 4
CitycityCity
State / ProvincemainDivisionCodeState / Province
Postal CodepostalCodePostal code
Country CodecountryCodeISO Country Code
Billing AddressbillToAddressBiilling Address
Billing Address Destination IDdestinationIdBilling address destination id; for example, billing_1
Shipping AddressshippingAddressShipping address
Shipping Address Destination IDdestinationIdShipping address destination id; for example, shipping_1
Order TotalorderTotalFulfillment order total
Grand TotalgrandTotalOrder total amount
Grand TaxgrandTaxTotal tax amount
Grand ChargegrandChargesTotal charges amount
Header TaxhdrTaxHeader Tax Amount
Header ChargeshdrChargesHeader level charges

JSON Example

Copy

{
  "holdTicketId": "100016910",
  "fulfillmentOrder": {
    "fulfillmentOrderId": "100052388534001",
    "storeId": "TMSUS",
    "nodeId": "TMS_NA-Store1",
    "omsOrderId": "100052388534",
    "webOrderId": "0002683939187653",
    "fulfillmentType": "STORE_PICK_UP",
    "currency": "USD",
    "carrier": "ISPU",
    "service": "ISPU",
    "fulfillmentOrderDate": "2017-12-05T17:52:39+00:00",
    "orderDate": "2017-12-05T17:52:19+00:00",
    "status": "1600.002",
    "totalVolume": {
      "unit": "CIN",
      "value": 1811.25
    },
    "totalWeight": {
      "unit": "LBS",
      "value": 8.05
    },
    "pickTicketId": "100016909",
    "holdLocation": "Ben-Test",
    "pinNumber" : 7298,
    "storeName": "PITTSBURGH-SOUTHSIDE SC",
    "fulfillmentOrderItems": [
      {
        "itemDetails": {
          "itemId": "21-ManGen001a",
          "itemDesc": "Black Tennis Shoes",
          "color" : "Hazel",
          "colorCode" : "300",
          "size" : "Size 6 - Medium",
          "sizeCode" : "6-M",
          "style" : "789",
          "upcs":[
            {
              "type":"G",
              "value":"1806505728"
            }
          ]
        },
        "orderedQuantity": 4,
        "quantity": 4,
        "holdQuantity": 4,
        "canceledQuantity": 0,
        "itemTotal": {
          "unitPrice": 114,
          "extendedPrice": 456,
          "charges": 0,
          "tax": 10.12
        }
      },
      {
        "itemDetails": {
          "itemId": "21-ManGen002a",
          "itemDesc": "Black Tennis Shoes",
          "color" : "Hazel",
          "colorCode" : "300",
          "size" : "6",
          "sizeCode" : "6-M",
          "style" : "1806505123",
          "upcs":[
            {
              "type":"G",
              "value":"1806505123"
            }
          ]
        },
        "orderedQuantity": 3,
        "quantity": 3,
        "holdQuantity": 3,
        "canceledQuantity": 0,
        "itemTotal": {
          "unitPrice": 114,
          "extendedPrice": 342,
          "charges": 0,
          "tax": 23.94
        }
      }
    ],
    "proxyPickupDetails": {
      "id": "proxyPickupAddress_1",
      "address": {
        "line1": "60 GREEN MOUNTAIN",
        "city": "HAZLETON",
        "mainDivisionCode": "PA",
        "countryCode": "US",
        "postalCode": "18202"
      },
      "personName": {
        "lastName": "Minimum1",
        "firstName": "Joe1"
      },
      "phone": "6100001000",
      "email": "someone@someone@com",
      "relationship": "Brother"
    },
    "destinations": [
      {
        "destinationId": "billing_1",
        "destinationType": "MAILING_ADDRESS",
        "personName": {
          "firstName": "Richard",
          "lastName": "Doyle"
        },
        "phone": "1111111111",
        "address": {
          "line1": "801 Hat Trick Avenue",
          "city": "Eveleth",
          "mainDivisionCode": "MN",
          "countryCode": "US"
        },
        "email": "RadialNRFCustomer1@gmail.com"
      },
      {
        "destinationId": "shipping_1",
        "destinationType": "SHIPPING_ADDRESS",
        "personName": {
          "firstName": "Richard",
          "lastName": "Doyle"
        },
        "address": {
          "line1": "SOUTHSIDE SHOPPING CTR",
          "line2": "2000 WHARTON ST  STE A",
          "city": "PITTSBURGH",
          "mainDivisionCode": "PA",
          "postalCode": "15203",
          "countryCode": "US"
        },
        "email": "4373wm1@rsonline.gsicommerce.com"
      }
    ],
    "billToAddress": {
      "destinationId": "billing_1"
    },
    "shippingAddress": {
      "destinationId": "shipping_1"
    },
    "orderTotal": {
      "grandTotal": 832.06,
      "grandTax": 34.06,
      "grandCharges": 0,
      "hdrTax": 0,
      "hdrCharges": 0
    }
  }
}

Return Receipt

Attributes

DataJSON Field NameDescription
Return Order IDorderIdReturn orderID
Order TypeorderTypeOrder type; for example, OMS
RMA IDrmaIdRMA number
Seller IDstoreSeller ID; for example, TMSUS
Store TypestoreTypeStore type; for example, Channel
Expiration DateexpiryDateReturn authorization expiration date
Return LocationreturnLocationReturn location
Location IDidReturn location (node) id
Return Location AddressaddressReturn location mailing address
Address LineaddressLineReturn location street address
CitycityCity
StatestateState
Postal CodezipCodePostal code
Country CodecountryISO country code
PhonedayPhoneReturn location phone number
Bill to AddressbillToAddress 
First NamefirstNameBill to person first name
Last NamelastNameBill to person last name
Address LineaddressLineCustomer street address
CitycityCity
StatestateState
Postal CodezipCodePostal code
Country CodecountryISO country code
PhonedayPhoneCustomer phone number
Weborder NumberwebOrderNumberWeborder Number
Document IDdocumentNumberReturn Receipt Document Number
Total Refund AmounttotalRefundAmountTotal refund amount
Total Charges AmounttotalChargesAmountTotal charges amount included in the refund amount
Total Discount AmounttotalDiscountAmountTotal discount amount
Total Tax AmounttotalTaxAmountTotal tax amount included in the refund amount
Header Custom AttributescustomAttributesOrder header custom attributes
Attribute listattributeListCustom attributes list
Attribute NamenameCustom attribute name
Attribute ValuevalueCustom attribute value
Order Already Taxed flagorderAlreadyTaxedOrder Already Taxed flag
Order LinesorderLinesOrder lines detail information
Line NumberlineNumberOrder line number
Ordered QuantityorderedQuantityLine item ordered quantity
Returned QuantityreturnedQuantityLine item returned quantity
Item IDitemIdRadial item ID
Item DescriptionitemDescriptionItem description
Unit PriceunitPriceAmountItem unit price
Item Gross AmountgrossAmountItem gross amount
Discount AmountdiscountAmountTotal item discount
Tax AmounttaxAmountItem tax amount
Refund AmountrefundAmountItem refund amount
Line ChargeslineCharges 
Line Charge ListlineChargeListA list of all line charges and discounts
Charge NamechargeNameCharge name
Charge AmountchargeAmountCharge amount
Line PricelinePriceCharge per line
Unit PriceunitPriceCharge per unit
Line TaxeslineTaxes 
Line Tax ListlineTaxListA list of all line taxes
Tax CategorytaxCategoryTax category
Tax AmounttaxAmountTax amount
Line Custom AttributecustomAttributesLine custom attribute
Attribute ListattributeListA list of order line custom attributes
Attribute NamenameCustom attribute name; for example, PVAR_DESC_COLOR
Attribute ValuevalueCustom attribute value; for example, Brown

JSON Example

Copy
{
   "orderId":"100055097614",
   "orderType":"OMS",
   "store":"TMSUS",
   "storeType":"Channel",
   "rmaId":"201902220062419",
   "expiryDate":"2021-01-13T16:24:11+0000",
   "returnLocation":{
      "id":"100801",
      "address":{
         "addressLine":[
            "1400 Main Street"
         ],
         "city":"DEVON",
         "state":"PA",
         "zipCode":"19333",
         "country":"US",
         "dayPhone":"6105551212"
      }
   },
   "billToAddress":{
      "firstName":"Richard",
      "lastName":"Doyle",
      "addressLine":[
         "801 Hat Trick Avenue"
      ],
      "city":"Eveleth",
      "state":"MN",
      "zipCode":"55734",
      "country":"US",
      "dayPhone":"1111111111"
   },
   "webOrderNumber":"0002698143115953",
   "documentNumber":"527141457",
   "totalRefundAmount":"114.00",
   "totalChargesAmount":"0.00",
   "totalDiscountAmount":"0.00",
   "totalTaxAmount":"0.00",
   "customAttributes":{
      "attributeList":[

      ]
   },
   "orderAlreadyTaxed":"N",
   "orderLines":[
      {
         "lineNumber":"1-1",
         "orderedQuantity":300,
         "returnedQuantity":1,
         "itemId":"21-ISPUProd02",
         "itemDescription":"Red Floral Dress",
         "unitPriceAmount":"114.00",
         "grossAmount":"114.00",
         "discountAmount":"0.00",
         "taxAmount":"0.00",
         "refundAmount":"114.00",
         "lineCharges":{
            "lineChargeList":[
               {
                  "chargeName":"Price",
                  "chargeAmount":"0.00",
                  "linePrice":"0.00",
                  "unitPrice":"0.00"
               }
            ]
         },
         "lineTaxes":{
            "lineTaxList":[
               {
                  "taxCategory":"Price",
                  "taxAmount":"0.00"
               }
            ]
         },
         "customAttributes":{
            "attributeList":[
               {
                  "name":"PVAR_CODE_COLOR",
                  "value":"700"
               },
               {
                  "name":"PVAR_DESC_COLOR",
                  "value":"Brown"
               },
               {
                  "name":"PVAR_LABEL_COLOR",
                  "value":"color"
               },
               {
                  "name":"PVAR_CODE_SIZE",
                  "value":"6-M"
               },
               {
                  "name":"PVAR_DESC_SIZE",
                  "value":"6-M"
               },
               {
                  "name":"PVAR_LABEL_SIZE",
                  "value":"Size"
               }
            ]
         }
      }
   ]
}

Order Receipt

Attributes

DataJSON Field NamesDescription
Cart IDcartIdCart ID
Seller IDstoreIdSeller ID
Weborder IDwebOrderIdWeborder number
Order TypeorderTypeOrder Type; for example, SALES
Order SourcesourceIdentifies where an order was originated; for example, InStore
LocalelocaleLocale; for example, en_US
Tax HeadertaxHeaderContains error response from Tax system
Error flagerrorIdentIdentifies if Tax call is resulted in error. Error flag value:true or false
Tax Transaction IDtaxTransactionIdTax Transaction ID
Pricing DatepricingDatePricing Date
CustomercustomerCustomer general information
Person NamepersonNameCustomer name
First NamefirstNameCustomer first name
Last NamelastName"Customer last name
Middle NamemiddleNameCustomer middle name
EmailemailCustomer email address
Loyalty ProgramsloyaltyProgramsLoaylty programs that a customer participates in
Loyalty NumberloyaltyNumberLoyalty number
Loyalty Program NameloyaltyProgNameLoyalty program name
LineslinesOrder lines
Line IDlineIdA unique line id (used as a reference withing the order)
Webline IDwebLineIdWeborder line id
QuantityquantityLine item quantity
Unit PriceunitPriceItem unit price
Line SubtotallineSubtotalLine Subtotal
ItemitemItem information
Item IDitemIdRadial Item ID
Item DescriptiondescriptionItem description
Estimated Delivery DateestimatedDeliveryDateEstimated Delivery Date
Delivery windowdeliveryWindowDelivery window
From DatefromFrom Delivery Date
To DatetoTo Delivery Date
Shipping WindowshippingWindowShipping window
From DatefromFrom Ship Date
To DatetoTo Ship Date
Message TypemessageTypeMessage Type: DeliveryDate
Expected ShipmentsexpectedShipmentsExpected Shipments
Available QuantitiesavailableQuantitiesAvailable quantities
QuantityquantityAvailable quantity
Ship from AddressshipFromAddressShip from address
Address Line1line1Address line 1
Address Line2line2Address line 2
Address Line3line3Address line 3
Address Line4line4Address line 4
CitycityCity
Province / StatemainDivisionCodeProvince / state
Postal CodepostalCodePostal Code
Country CodecountryCodeCountry code
Colorcolor 
Color CodecodeColor code
Color DescriptiondescriptionColor description
Sizesize 
Size CodecodeSize code
Size DescriptionsdescriptionSize description
Estimated Delivery DateestimatedDeliveryDateEstimated Delivery Date
Delivery windowdeliveryWindowDelivery window
From DatefromFrom Delivery Date
To DatetoTo Delivery Date
Shipping WindowshippingWindowShipping window
From DatefromFrom Ship Date
To DatetoTo Ship Date
Message TypemessageTypeMessage Type: DeliveryDate
Unavailable QuantityunavailableQuantityUnavailable quantity
AttributesattributesLine attributes
Promotion CodespromotionCodesPromotion codes applied
PromotionspromotionsPromotions applied
DestinationsdestinationsOrder destinations, i.e. shipping / billing address information
Destination IDdestinationIdDestination ID
Destination TypedestinationTypeDesttionation type; for example, MAILING_ADDRESS
Person NamepersonNamePerson name
First NamefirstNameFirst name
Last NamelastNameLast name
Middle NamemiddleNameMiddle name
HonorifichonorificHonorific
PhonephonePhone number
AddressaddressAddress
Address Line1line1Address line1
Address Line2line2Address line2
Address Line3line3Address line3
Address Line4line4Address line4
CitycityCity
State / ProvincemainDivisionCodeState / Province
Postal CodepostalCodePostal code
Country CodecountryCodeCountry code
Ship GroupsshipGroupsShip groups
Ship Group IDshipGroupIdShip group Id
Fulfillment TypefulfillmentTypeFulfillment type; for example, SHIP_TO_HOME
Charge TypechargeTypeCharge type; for example, FLATRATE
Shipping MethodshippingMethodShipping method
CarriercarrierCarrier SCAC code
ServiceserviceCarrier service level; for example, STD
SCAC and Service CombinedscacServiceSCAC and service combined together; for example, ANY_STD
Display TextdisplayTextSipping Method description, e.gStandard Ground
Destination ID ReferencedestinationIdRefDestination ID reference
Line ID ReferenceslineIdRefsLine ID references
PaymentspaymentsOrder Payment information
Payment TypepaymentTypePayment type; for example, CREDIT_CARD
Payment IDpaymentIdA unique payment id within an order
AmountamountAmount
Suspended flagsuspendedIdentifies if payment is suspended
Primary Account NumberprimaryAccountNumberPrimary account number
TypetypeAccount number type; for example, TOKEN
ValuevalueMasked Account Number
Tender TypetenderTypeTender type; for example, VC
Expiration DateexpirationDateCredit card expiration date
IsPLCC flagisPLCCIdentifies if the payment method is a private label credit card
Billing Address RefferencebillingAddressRefDestination ID of the billing address (see Destinations)
ChargeschargesOrder charges
Total Charge AmounttotalChargeOrder total charge amount
Total DiscounttotalDiscountTotal charge discount
Net AmountnetAmountTotal net amount (after discount)
Total Base AmounttotalBaseTotal base amount
Total Promotion DiscounttotalPromotionTotal promotion discount
Total Adjustment amounttotalAdjustmentTotal adjustment amount
Line Charge GroupslineChargeGroups 
Line IDlineIdOrder line unique id within the order
Total Charge AmounttotalChargeLine total charge amount
Total DiscounttotalDiscountLine total charge discount
Net AmountnetAmountLine charge net amount (after discount)
Total Base AmounttotalBaseLine charge base amount
Total Promotion DiscounttotalPromotionLine charge promotion discount
Total Adjustment amounttotalAdjustmentLine charge adjustment amount
Charge GroupschargeGroups 
Charge Group NamenameCharge Group Name; for example, Shipping
Total ChargetotalChargeTotal charge amount
Total DiscounttotalDiscountTotal charge discount
Net AmountnetAmountCharge net amount (after discount)
Total Base AmounttotalBaseCharge base amount
Total Promotion DiscounttotalPromotionCharge promotion discount
Total Adjustment amounttotalAdjustmentCharge adjustment amount
Adjustment CategoryadjustmentCategoryAdjustment category; for example, ShippingCredit
Chargescharges 
NamenameCharge name; for example, Shipping
CategorycategoryCharge category; for example, Shipping
Charge TypechargeTypeCharge type; for example, BASE
Unit ChargeunitChargeCharge per unit
Line ChargelineChargeCharge per line
AmountamountCharge amount
Discount flagdiscountSpecifies if a charge is discount. Value: true or false
Derived flagderivedSpecifies if a charge is derived. Value: true or false
Date CreateddateCreatedCharge created date
TaxestaxesOrder taxes
Total TaxtotalTaxOrder total tax amount
Total DiscounttotalDiscountOrder total tax discount
Net AmountnetAmountOrder tax net amount
Line taxeslineTaxes 
Line IDlineIDOrder line unique id within the order
Total TaxtotalTaxLine total tax amount
Total DiscounttotalDiscountLine total tax discount
Net AmountnetAmountLine tax net amount
TaxestaxesA list of all applicable line taxes
NamenameTax name; for example, Price, Shipping, etc.
Tax TypetaxTypeTax Type; for example, BASE
CategorycategoryTax category; for example, Price, Shipping, etc.
AmountamountTax amount
Tax DetailstaxDetailsTax details
Tax Detail TypetaxDetailTypeTax detail type; for example, SALES
TaxabilitytaxabilityTaxability; for example, TAXABLE
SitussitusSitus; for example, ADMINISTRATIVE_ORIGIN
JurisdictionjurisdictionJurisdiction
Jurisdiction leveljurisdictionLevelJurisdiction level; for example, STATE
Jurisdiction IDjurisdictionIdJurisdiction id
ValuevalueJuristiction value; for example, PENNSYLVANIA
ImpositionimpositionImposition
Imposition TypeimpositionTypeImposition type; for example, General Sales and Use Tax
ValuevalueImposition value; for example, Sales and Use Tax
Tax Effective RateeffectiveRateTax effective rate
Taxable AmounttaxableAmountTaxable amount
Calculated TaxcalculatedTaxCalculated tax amount
TotalstotalsOrder totals
Line TotalslineTotalsA list of line totals
Line IDlineIdLine Id
Line TotallineTotalLine grand total amount (includes tax, charges, discount)
Charge Group TotalschargeGroupTotalsCharge Group total
Charge Group NamechargeGroupNameCharge group name
Total ChargetotalChargeTotal charge amount
Total DiscounttotalDiscountTotal discount amount
Net AmountnetAmountNet amount
Total Base AmounttotalBaseTotal base amount
Total PromotiontotalPromotionTotal promotion discount
Total Adjustment amounttotalAdjustmentTotal adjustment amount
Lines SubtotallineSubtotalLines subtotal
Lines Grand TotalgrandTotalLines grand total amount (includes tax, charges, discount)
Shipping Total ChargesshippingTotalChargesShipping total charges
Shipping Total PromotionshippingTotalPromotionChargesShipping total promotion discount
Promotion Total ChargespromotionTotalChargesMerchandise total promotion discount

JSON Example

Copy
{
  "cartId" : "106058",
  "storeId" : "TMSUS",
  "webOrderId" : "00250106058",
  "orderType" : "SALES",
  "source" : "InStore",
  "currency" : "USD",
  "locale" : "en_US",
  "taxHeader" : {
      "error" : false,
      "taxTransactionId" : "6031302"
  },
  "pricingDate" : "2019-02-05T14:42:47.858Z",
  "customer" : {
      "personName" : {
        "firstName" : "asdf",
        "lastName" : "asdf",
        "middleName" : ""
      },
      "email" : "test@test.com",
      "loyaltyPrograms" : [ ]
  },
  "lines" : {
      "lineId1" : {
        "lineId" : "lineId1",
        "webLineId" : 1,
        "quantity" : 2,
        "unitPrice" : 10.0,
        "lineSubtotal" : 20.0,
        "item" : {
            "itemId" : "21-ManGen003a",
            "description" : "Manual Test Order 3"
        },
        "estimatedDeliveryDate" : {
            "deliveryWindow" : {
              "from" : "2019-02-06T00:00:00Z",
              "to" : "2019-02-10T00:00:00Z"
            },
            "shippingWindow" : {
              "from" : "2019-02-05T00:00:00Z",
              "to" : "2019-02-06T00:00:00Z"
            },
            "messageType" : "DeliveryDate"
        },
        "expectedShipments" : {
            "availableQuantities" : [ {
              "quantity" : 2,
              "shipFromAddress" : {
                  "line1" : "16 Madison way",
                  "city" : "Downingtown",
                  "mainDivisionCode" : "PA",
                  "postalCode" : "19335",
                  "countryCode" : "US"
              },
              "estimatedDeliveryDate" : {
                  "deliveryWindow" : {
                    "from" : "2019-02-06T00:00:00Z",
                    "to" : "2019-02-10T00:00:00Z"
                  },
                  "shippingWindow" : {
                    "from" : "2019-02-05T00:00:00Z",
                    "to" : "2019-02-06T00:00:00Z"
                  },
                  "messageType" : "DeliveryDate"
              }
            } ],
            "unavailableQuantity" : 0
        },
        "attributes" : [ ]
      }
  },
  "promotionCodes" : {
  },
  "promotions" : {
  },
  "destinations" : {
      "destination1" : {
        "destinationId" : "destination1",
        "destinationType" : "MAILING_ADDRESS",
        "personName" : {
            "firstName" : "asdf",
            "lastName" : "asdf",
            "middleName" : "",
            "honorific" : ""
        },
        "phone" : "1231231234",
        "address" : {
            "line1" : "234 asdfa",
            "line2" : "",
            "line3" : "",
            "line4" : "",
            "city" : "king of prussia",
            "mainDivisionCode" : "PA",
            "postalCode" : "19146",
            "countryCode" : "US"
        }
      }
  },
  "shipGroups" : {
      "shipGroup1" : {
        "shipGroupId" : "shipGroup1",
        "fulfillmentType" : "SHIP_TO_HOME",
        "chargeType" : "FLATRATE",
        "shippingMethod" : {
            "carrier" : "ANY",
            "service" : "STD",
            "scacService" : "ANY_STD",
            "displayText" : "Standard Ground"
        },
        "destinationIdRef" : "destination1",
        "lineIdRefs" : [ "lineId1" ]
      }
  },
  "payments" : {
      "payment1" : {
        "paymentType" : "CREDIT_CARD",
        "paymentId" : "payment1",
        "amount" : 26.5,
        "suspended" : false,
        "primaryAccountNumber" : {
            "type" : "TOKEN",
            "value" : "411111vjOiXS1111"
        },
        "tenderType" : "VC",
        "isMockPayment" : false,
        "customAttributes" : [ ],
        "expirationDate" : "2022-04",
        "isPLCC" : false,
        "useAlternateMerchantId" : false
      }
  },
  "billingAddressRef" : "destination1",
  "charges" : {
      "totalCharge" : 5.0,
      "totalDiscount" : 0,
      "netAmount" : 5.0,
      "totalBase" : 5.0,
      "totalPromotion" : 0,
      "totalAdjustment" : 0,
      "lineChargeGroups" : {
        "lineId1" : {
            "lineId" : "lineId1",
            "totalCharge" : 5.0,
            "totalDiscount" : 0,
            "netAmount" : 5.0,
            "totalBase" : 5.0,
            "totalPromotion" : 0,
            "totalAdjustment" : 0,
            "chargeGroups" : {
              "Shipping" : {
                  "name" : "Shipping",
                  "totalCharge" : 5.0,
                  "totalDiscount" : 0,
                  "netAmount" : 5.0,
                  "totalBase" : 5.0,
                  "totalPromotion" : 0,
                  "totalAdjustment" : 0,
                  "adjustmentCategory" : "ShippingCredit",
                  "charges" : [ {
                    "name" : "Shipping",
                    "category" : "Shipping",
                    "chargeType" : "BASE",
                    "unitCharge" : 0,
                    "lineCharge" : 5.0,
                    "amount" : 5.0,
                    "discount" : false,
                    "derived" : false,
                    "dateCreated" : "2019-02-05T14:48:48.693Z",
                    "informational" : false
                  } ]
              }
            }
        }
      }
  },
  "taxes" : {
      "totalTax" : 1.5,
      "totalDiscount" : 0,
      "netAmount" : 1.5,
      "lineTaxes" : {
        "lineId1" : {
            "lineId" : "lineId1",
            "totalTax" : 1.5,
            "totalDiscount" : 0,
            "netAmount" : 1.5,
            "taxes" : [ {
              "name" : "Price",
              "category" : "Price",
              "taxType" : "BASE",
              "amount" : 1.2,
              "discount" : false,
              "derived" : false,
              "taxDetails" : [ {
                  "taxDetailType" : "SALES",
                  "taxability" : "TAXABLE",
                  "situs" : "ADMINISTRATIVE_ORIGIN",
                  "jurisdiction" : {
                    "jurisdictionLevel" : "STATE",
                    "jurisdictionId" : "31152",
                    "value" : "PENNSYLVANIA"
                  },
                  "imposition" : {
                    "impositionType" : "General Sales and Use Tax",
                    "value" : "Sales and Use Tax"
                  },
                  "effectiveRate" : 0.06,
                  "taxableAmount" : 20.0,
                  "calculatedTax" : 1.2
              } ]
            }, {
              "name" : "Shipping",
              "category" : "Shipping",
              "taxType" : "BASE",
              "amount" : 0.3,
              "discount" : false,
              "derived" : false,
              "taxDetails" : [ {
                  "taxDetailType" : "SALES",
                  "taxability" : "TAXABLE",
                  "situs" : "ADMINISTRATIVE_ORIGIN",
                  "jurisdiction" : {
                    "jurisdictionLevel" : "STATE",
                    "jurisdictionId" : "31152",
                    "value" : "PENNSYLVANIA"
                  },
                  "imposition" : {
                    "impositionType" : "General Sales and Use Tax",
                    "value" : "Sales and Use Tax"
                  },
                  "effectiveRate" : 0.06,
                  "taxableAmount" : 5.0,
                  "calculatedTax" : 0.3
              } ]
            } ]
        }
      }
  },
  "totals" : {
      "lineTotals" : {
        "lineId1" : {
            "lineId" : "lineId1",
            "lineTotal" : 26.5
        }
      },
      "chargeGroupTotals" : {
        "Shipping" : {
            "chargeGroupName" : "Shipping",
            "totalCharge" : 5.0,
            "totalDiscount" : 0,
            "netAmount" : 5.0,
            "totalBase" : 5.0,
            "totalPromotion" : 0,
            "totalAdjustment" : 0
        }
      },
      "lineSubtotal" : 20.0,
      "grandTotal" : 26.5
  },
  "templates" : [ ],
  "attributes" : [ ],
  "inError" : false,
  "cartIdGenerator" : {
      "nextLineId" : 2,
      "nextDestinationId" : 2,
      "nextShipGroupId" : 2,
      "nextPaymentId" : 2,
      "nextCartEventId" : 43,
      "nextShipmentId" : 1,
      "nextContainerId" : 1,
      "nextWebLineId" : 2,
      "nextCustomizationId" : 1
  },
  "version" : 20,
  "lastEventSequenceConsumed" : 7,
  "shippingTotalCharges": 15.0,
  "shippingTotalPromotionCharges": -10.00,
  "promotionTotalCharges": 0
}