Returns required custom details

GET

/content/fields/customs-detail

GET

/api/trade/compliance/v2/content/fields/customs-detail

curl https://onlinetools.ups.com/api/trade/compliance/v2/content/fields/customs-detail \
     -H "transId: transId" \
     -H "transactionSrc: transactionSrc" \
     -H "Authorization: Bearer <token>"

{
  "commodityCodes": [
    {
      "commodityCode": "2926400000",
      "regulations": [
        {
          "regulation": "FDA",
          "regulationSections": [
            {
              "sectionKey": "DRU"
            }
          ]
        }
      ]
    },
    {
      "commodityCode": "3003395000",
      "regulations": [
        {
          "regulation": "FDA",
          "regulationSections": [
            {
              "sectionKey": "DRU"
            }
          ]
        }
      ]
    }
  ],
  "fieldGroups": [
    {
      "countryCode": "US",
      "shipmentType": "Import",
      "groupKey": "US-IMP-FDA",
      "details": "This is for US import FDA fields",
      "regulation": "FDA",
      "regulationSections": [
        {
          "sectionKey": "Cos",
          "sectionName": "Cosmetics"
        },
        {
          "sectionKey": "Bio",
          "sectionName": "Biologics"
        },
        {
          "sectionKey": "Dev",
          "sectionName": "Device"
        },
        {
          "sectionKey": "Foo",
          "sectionName": "Food"
        }
      ],
      "fields": [
        {
          "sectionKey": "MnuNa",
          "label": "Manufacturer Name",
          "order": "1",
          "tooltip": "Type of shipping bill to be processed for the shipment",
          "isRequired": "C",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "requirementConditions": [
            {
              "fieldKey": "MnuPslCd",
              "operator": "!=",
              "value": ""
            }
          ],
          "keyAlias": "ManufacturerName",
          "level": "Product"
        },
        {
          "sectionKey": "MnuPslCd",
          "label": "Manufacturer Postal Code",
          "order": "8",
          "tooltip": "The postal code address of the manufacturer for the product",
          "isRequired": "Y",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerPostalCode",
          "level": "Product"
        },
        {
          "sectionKey": "MnuAdLn1Te",
          "label": "Manufacturer Address Line 1",
          "order": "1",
          "tooltip": "Line 1 of the address of the manufacturer for the product",
          "isRequired": "N",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerAddressLine1",
          "level": "Product"
        },
        {
          "sectionKey": "MnuAdLn2Te",
          "label": "Manufacturer Address Line 2",
          "order": "1",
          "tooltip": "Line 2 of the address of the manufacturer for the product",
          "isRequired": "N",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerAddressLine2",
          "level": "Product"
        },
        {
          "sectionKey": "MnuAdLn3Te",
          "label": "Manufacturer Address Line 3",
          "order": "1",
          "tooltip": "Line 3 of the address of the manufacturer for the product",
          "isRequired": "N",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerAddressLine3",
          "level": "Product"
        },
        {
          "sectionKey": "MnuCtyNa",
          "label": "Manufacturer City Name",
          "order": "1",
          "tooltip": "Line 3 of the address of the manufacturer for the product",
          "isRequired": "N",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerAddressLine3",
          "level": "Product"
        },
        {
          "sectionKey": "MnuStPrvCd",
          "label": "Manufacturer State/Province Code",
          "order": "1",
          "tooltip": "The state/province for the address of the manufacturer for the product",
          "isRequired": "N",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerStateProvinceCode",
          "level": "Product"
        },
        {
          "sectionKey": "MnuCtyCd",
          "label": "Manufacturer Country Code",
          "order": "1",
          "tooltip": "The country code for the address of the manufacturer for the product",
          "isRequired": "N",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerCountryCode",
          "level": "Product"
        },
        {
          "sectionKey": "MnuPslCd",
          "label": "Manufacturer Postal Code",
          "order": "1",
          "tooltip": "The postal code address of the manufacturer for the product",
          "isRequired": "Y",
          "fieldType": "textbox",
          "allowedValueCount": 1,
          "validation": {
            "minLength": 1,
            "maxLength": 10,
            "errorMessage": "Enter a valid value",
            "dataType": "Text",
            "listValues": []
          },
          "regulationSections": [
            {
              "sectionKey": "Cos"
            },
            {
              "sectionKey": "Bio"
            },
            {
              "sectionKey": "Dev"
            },
            {
              "sectionKey": "Foo"
            }
          ],
          "keyAlias": "ManufacturerPostalCode",
          "level": "Product"
        }
      ],
      "countryName": "UNITED STATES OF AMERICA"
    }
  ]
}

This returns an array of fields that are required for the provided import and/or export country

Authentication

AuthorizationBearer

Find your Client ID and Secret on your app info page. 1. Select "Try It" 2. In the Security section enter your Client ID and Secret 3. Select "Request Token" 4. Enter any additional information in the Body and Parameters sections 5. Select "Send" to execute your API request"

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

import_country_codestring or nullOptionalformat: "^[A-Z]{2}$"=2 characters

export_country_codestring or nullOptionalformat: "^[A-Z]{2}$"=2 characters

localestringOptionalformat: "^[a-z]{2}-[A-Z]{2}$"=5 charactersDefaults to en-US

commodity_codesstring or nullOptional1-2000 characters

Optional comma-separated list of tariff codes to filter results.

Response headers

BkndTransIdstringOptional

The backend transaction id.

TransIdstringOptional

An identifier unique to the request.

transactionSrcstringOptional

Identifies the client/source application that is calling.

Content-TypestringOptional

The Content-Type header provides the client with the actual content/media type of the returned content.

Response

Success

commodityCodeslist of objects

Unbounded list of commodity codes and their associated compliance Regulations.

fieldGroupslist of objectsOptional

Unbounded list of field group definitions grouped by country, shipment type, and Regulation.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Query parameters

Response headers

Response

Errors