Validate and/or submit the fields | UPS API Documentation

curl -X POST https://onlinetools.ups.com/api/trade/compliance/v2/content/fields/customs-detail \
     -H "transId: transId" \
     -H "transactionSrc: transactionSrc" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "actionType": "save",
  "shipperNumber": "1443YY",
  "trackingNumber": "1Z1443YY0161231327",
  "shipmentMetaData": [
    {
      "fields": [
        {
          "fieldKey": "ImportLicenseNumber",
          "fieldValue": "123412351234123",
          "regulationSections": [
            {
              "sectionKey": "Bio"
            }
          ]
        }
      ],
      "groupKey": "US-IMP-CDC"
    },
    {
      "fields": [
        {
          "fieldKey": "CSBType",
          "fieldValue": "3",
          "regulationSections": [
            {
              "sectionKey": "CSB"
            }
          ]
        },
        {
          "fieldKey": "IECCode",
          "fieldValue": "99",
          "regulationSections": [
            {
              "sectionKey": "CSB"
            }
          ]
        }
      ],
      "groupKey": "IN-EXP-CSB"
    }
  ],
  "products": [
    {
      "productId": "PART-001",
      "productDescription": "Medical device",
      "productMetaData": [
        {
          "fields": [
            {
              "fieldKey": "Amount",
              "fieldValue": "10",
              "regulationSections": [
                {
                  "sectionKey": "CSB"
                }
              ]
            },
            {
              "fieldKey": "CurrencyCode",
              "fieldValue": "USD",
              "regulationSections": [
                {
                  "sectionKey": "CSB"
                }
              ]
            }
          ],
          "groupKey": "IN-EXP-CSB"
        },
        {
          "fields": [
            {
              "fieldKey": "MnuNa",
              "fieldValue": "UPS Labs",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            },
            {
              "fieldKey": "MnuAdLn1Te",
              "fieldValue": "55 Glenlake Pkwy NE",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            },
            {
              "fieldKey": "MnuAdLn2Te",
              "fieldValue": "Suite 400",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            },
            {
              "fieldKey": "MnuAdLn3Te",
              "fieldValue": "Building C",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            },
            {
              "fieldKey": "MnuCtyNa",
              "fieldValue": "Atlanta",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            },
            {
              "fieldKey": "MnuStPrvCd",
              "fieldValue": "GA",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            },
            {
              "fieldKey": "MnuCtyCd",
              "fieldValue": "US",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            },
            {
              "fieldKey": "MnuPslCd",
              "fieldValue": "30301",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                },
                {
                  "sectionKey": "Bio"
                },
                {
                  "sectionKey": "Dev"
                },
                {
                  "sectionKey": "Foo"
                }
              ]
            }
          ],
          "groupKey": "US-IMP-FDA"
        }
      ],
      "commodityCode": "3821000010"
    },
    {
      "productId": "PART-002",
      "productDescription": "Sample pharma goods",
      "productMetaData": [
        {
          "fields": [
            {
              "fieldKey": "MnuNa",
              "fieldValue": "UPS Labs",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                }
              ]
            },
            {
              "fieldKey": "MnuPslCd",
              "fieldValue": "30301",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                }
              ]
            },
            {
              "fieldKey": "MnuAdLn1Te",
              "fieldValue": "55 Glenlake Pkwy NE",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                }
              ]
            },
            {
              "fieldKey": "MnuCtyNa",
              "fieldValue": "Atlanta",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                }
              ]
            },
            {
              "fieldKey": "MnuStPrvCd",
              "fieldValue": "GA",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                }
              ]
            },
            {
              "fieldKey": "MnuCtyCd",
              "fieldValue": "US",
              "regulationSections": [
                {
                  "sectionKey": "Cos"
                }
              ]
            }
          ],
          "groupKey": "US-IMP-FDA"
        }
      ],
      "commodityCode": "300490"
    }
  ]
}'

This endpoint will provide the ability to validate and/or submit the additional field information for a shipment

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.

Request

This endpoint expects an object.

actionTypeenumRequired

Specify the intent of the request. 'Save' will inherently perform validation.

Allowed values:

shipperNumberstringOptional=6 characters

This represents the shipper account number. Required when actionType is save.

trackingNumberstringOptionalformat: "^1Z[0-9A-Z]{16}$"=18 characters

Tthe lead 1Z number fore the shipment. Required when actionType is save.

shipmentMetaDatalist of objectsOptional

Unbounded list of containers for product metadata groups

productslist of objectsOptional

Unbounded list of containers for products included on the shipment being updated

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

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Request

Response headers

Response

Errors