GET /reference-data

Please provide version of the plugin (applicable to 3PV only)

Please provide version of the shipping platform (applicable to 3PV only)

Please provide version of the webstore platform (applicable to 3PV only)

Optional reference date in the HTTP-date format https://tools.ietf.org/html/rfc7231#section-7.1.1.2

Please provide name of the webstore platform (applicable to 3PV only)

Please provide name of the shipping platform(applicable to 3PV only)

Please provide message reference

Please provide name of the plugin (applicable to 3PV only)

Must provide at least one datasetName value. If providing just the datasetName with no filterBy fields - the response will return the entire data set from the dataset table (bulk).

Possible values:

• "customerPackageReferenceType"
• "invoiceReferenceType"
• "country"
• "packageTypeCode"
• "unitOfMeasurement"
• "documentTypeCode"
• "countryPostalcodeFormat"
• "invoiceItemReferenceType"
• "trackingEventCode"
• "all"
• "registrationNumberTypeCode"
• "serviceCode"
• "returnStatusMessage"
• "commodityCategory"
• "dangerousGoods"
• "productCode"
• "incoterm"
• "customerShipmentReferenceType"

Use filter by attribute to define the list of supported attibuted for the specified datasetName.
List of supported attributes per dataset
(eg. dataset: supported filterByAttributes values)

a) country: countryCode, countryName
b) countryPostalcodeFormat: countryCode
c) dangerousGoods: serviceCode
d) incoterm: incoterm
e) productCode: productCode, countryCode, docNonDocIndicator
f) serviceCode: serviceCode, countryCode, chargeCodeTypeCode, serviceGroupDescription
g) packageTypeCode: packageTypeCode
h) documentTypeCode: customsDocumentTypeCode
i) customerShipmentReferenceType: shipmentReferenceTypeCode
j) customerPackageReferenceType: packageReferenceTypeCode
k) invoiceReferenceType: invoiceReferenceTypeCode
l) invoiceItemReferenceType: itemReferenceTypeCode
m) registrationNumberTypeCode: registrationTypeCode
n) commodityCategory: commodityCategoryCode, commodityCategoryGroup, commodityCategoryDescription
o) returnStatusMessage: statusCode, serviceName, operationName, protocol
p) trackingEventCode: eventTypeCode, eventTypeDescription, visibleToCustomer
q) unitOfMeasurement: unitOfMeasurement

Use comparison operator to define the specific match condition for optimized search.

Possible values:

• "contains"
• "notEqual"
• "equal"

Default value: "equal"

Use queryString for additional filter criteria in format of '[attribute]:[value]:[comparisonOperator]'.
All additional filters are applied together with logical connector 'AND'.
Maximum of three additional attribute-value-comparisonOperator combinations.
Multiple queryString parameters will be separated by comma "," separator

Use filter by value to query based on the specific string for optimized search.

List of supported filterByValue per dataset (eg. dataset: filterByAttribute| supported filterByValue)

a) returnStatusMessage: serviceName|CreateShipment,DocumentImageRequest,RateRequest,RequestIdentifier,RequestPickup,AddressValidateRequest,TrackingRequest,UpdatePickup,UpdateShipment,UploadInvoiceData,DeleteShipment,DocumentRetrieve-ePOD
b) returnStatusMessage: operationName|get-image,identifiers,address-validate, RouteRequest, shipments, tracking, upload-image,landed-cost,rates,upload-invoice-data,pickup,proof-of-delivery
c) returnStatusMessage: protocol|REST,SOAP,XMLPI
d) productCode: docNonDocIndicator|Y,N