Docs
Assignment APIAssignment

Get assignments by taxonomy

Security groups:Assigners
GET
/assignments/{taxonomy}

Returns a paged list of assignments for the given taxonomy. Results can be filtered by assignment status, strategy, product IDs, shop, labels, and product type (global or local), and sorted by several product and assignment attributes.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

taxonomy*string

The classification system to use.

  • TARIC: The Integrated Tariff of the European Union, used for EU customs classification.
  • TARES: The Swiss customs tariff, used for goods imported into Switzerland.
  • UKGT: The UK Global Tariff, used for goods imported into the United Kingdom.
Value in"TARIC" | "TARES" | "UKGT"

Query Parameters

shopIds?array<>

Filter by shop. Pass -1 to return assignments for products that are not linked to any shop. Accepts multiple values as repeated parameters or as a comma-separated list.

application?string

Filters assignments by the eClear application they belong to. VAT-RULES covers VAT classification. CLEAR-VAT and CLEAR-CUSTOMS are for the clearVAT and clearCustoms services respectively.

Value in"VAT-RULES" | "CLEAR-VAT" | "CLEAR-CUSTOMS"
lastModifiedDate?string

Return assignments that have an assignment lastModifiedDate later or equal to the lastModifiedDate specified

detail?string

Controls how much assignment data is included: Small returns status and product class code, Medium (default) adds strategy, dates, and auto-assignment status, Large returns the full record including UUID, labels, eClear code, and URL.

Default"Medium"
Value in"Small" | "Medium" | "Large"
assignmentStatus?array<>

Filter by assignment status. Accepts multiple values as repeated parameters or as a comma-separated list.

Items1 <= items
assignmentStatuses?array<>Deprecated

Filter the assignments based on their status. Allows multiple status values. It is deprecated, please use assignmentStatus.

assignmentStrategies?array<string>

Filter assignments by the strategy used to create them. Valid values are:

  • MANUAL: Assigned manually by a user.
  • CUSTOMS-CODE: Assigned based on the customs code of the product.
  • NEAREST-CUSTOMS-CODE: Assigned based on the nearest matching customs code.
  • DESCRIPTION: Assigned by matching product descriptions using a machine learning model.
  • Customer Specific Assignment Rule: The name of an assignment rule that you have configured. Accepts multiple values as repeated parameters or as a comma-separated list.
Items1 <= items
isGlobal?boolean

If true, returns assignments for global products only. If false, returns assignments for local products only. If omitted, returns assignments for both.

page?
filterCriteria?string

A URL-encoded JSON array of filter objects. Fields within one object are combined with AND; use operation to chain multiple objects with AND or OR.

Fields per object

FieldMatches againstNotes
productIdproductId
productNameproductNameRequires languageKey
productDescriptionproductDescriptionRequires languageKey
productTagproductTagsRequires languageKey
tariffNumberproduct class code
languageKey—en or de. Required when using productName, productDescription, or productTag
operation—AND or OR. Joins this object to the next. Ignored on the last object.

All searches use partial matching — "app" matches "apple juice".

Search expression syntax

SyntaxMeaningExample
a ba AND bapple juice — must contain both
a or ba OR bapple or juice — must contain either
a -ba AND NOT bapple -juice — contains apple, not juice
"a b"phrase — words adjacent"apple juice" — apple immediately before juice
"a b"phrase — one word in between"apple juice" — apple, any word, then juice

Performance: Very short search values (e.g. a single character) can cause slow responses or 503 errors.

Example

[
  { "productId": "a-product-id", "operation": "OR" },
  { "languageKey": "de", "productName": "Tast" }
]
sort?string

Comma-separated list of sort fields. Prefix each field with + for ascending or - for descending order.

Default"-lastModifiedDate"
Lengthlength <= 40
Value in"-productId" | "+productId" | "-productName" | "+productName" | "-productTag[0]" | "+productTag[0]" | "-productTag[1]" | "+productTag[1]" | "-productTag[2]" | "+productTag[2]" | "-productTag[3]" | "+productTag[3]" | "-productTag[4]" | "+productTag[4]" | "-autoAssignmentStatus" | "+autoAssignmentStatus" | "-lastModifiedDate" | "+lastModifiedDate" | "-productDescription" | "+productDescription" | "-actionReason" | "+actionReason" | "-vatRules.productClassCode" | "+vatRules.productClassCode"
productIds?array<>

Filter results to the specified product IDs. Accepts multiple values as repeated parameters or as a comma-separated list.

Itemsitems <= 100
labels?array<string|null>

Filter by label. Pass one or more label names to return only assignments that carry those labels. Prefix a label with ! to exclude assignments that carry it. Use - to return assignments with no labels at all. Accepts multiple values as repeated parameters or as a comma-separated list.

includeCounts?boolean

Optional boolean flag indicating whether aggregate count information (e.g., total count, filtered count) should be included in the response.

Defaultfalse

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/assignments/TARIC?sort=%2BproductName%2C-productId.&productIds=123&labels=Important%2CWIP%2C%21LATER"
{
  "data": [
    {
      "detail": "Small",
      "productId": "pid-12345",
      "shopIds": [
        101,
        102
      ],
      "productName": "Samsung Galaxy Tab S7 Fe, 12.4 Inch, 64 GB Internal Memory, 4 GB RAM,  Wi-Fi, Android Tablet including S Pen, Mystic Black\n",
      "productDescription": "Enjoy the brilliant colours of the Galaxy Tab S7 FE Wi-Fi  12.4 inch / 31.50 cm display. The vivid screen lets details  shine and the cinema experience is enhanced by the incredible  sound by AKG Equipped with a powerful Snapdragon 750G chip set,  the Galaxy Tab S7 FE Wi-Fi ensures smooth and fast streaming and  gaming. You can effortlessly multitask and launch up to three  apps at once Hour after hour before you need to recharge the  10.090 mAh battery (typical). When watching videos, it lasts up  to 13 hours, so you have enough time for a series marathon. The  included low-latency S pen provides a smooth writing experience.  More: In real time, it converts handwriting into print font and  you can easily edit text, then put it on the magnetic holder so  that it recharges itself. Immerse yourself in the colour splendour  of the 31.50 cm / 12.4 inch display of the Galaxy Tab S7 FE Wi-Fi  | Tab S7 FE 5G. Experience exciting movie moments with Sound by AKG  and look forward to a colourful display that literally brings any  amount of detail to life. The dual speakers and Dolby Atmos can  also provide a room-filling surround sound, so you feel like  you're in the middle of the action.\n",
      "productTags": [
        "tag1",
        "tag2",
        "tag3",
        "tag4"
      ],
      "subscribedEclearServices": {
        "clearVat": {
          "productClassCode": "1232134",
          "assignmentStatus": "ASSIGNED",
          "assignmentVersion": 1,
          "validFrom": "2023-01-01T00:00:00Z",
          "assignmentStrategy": "CUSTOMS-CODE",
          "actionReason": "Initial assignment",
          "autoAssignmentStatus": "INQUEUE",
          "fixedWidthProductClass": "1232134000",
          "eclearCode": "1232134000-00-000",
          "isEndNode": false,
          "assignmentUrl": "https://dev.eclear-solutions.com/ec-productassignment-be/assignments/TARIC/ee30676e-1a21-4caf-975f-26f71f5bfbdf",
          "assignmentUuid": "ee30676e-1a21-4caf-975f-26f71f5bfbdf"
        },
        "vatRules": {
          "productClassCode": "1232134",
          "assignmentStatus": "ASSIGNED",
          "assignmentVersion": 1,
          "validFrom": "2023-01-01T00:00:00Z",
          "assignmentStrategy": "MANUAL",
          "actionReason": "Initial assignment",
          "autoAssignmentStatus": "INQUEUE",
          "fixedWidthProductClass": "1232134000",
          "eclearCode": "1232134000-00-000",
          "isEndNode": false,
          "assignmentUrl": "https://dev.eclear-solutions.com/ec-productassignment-be/assignments/TARIC/1e6be043-74f6-4992-833d-9df6607b1f11",
          "assignmentUuid": "1e6be043-74f6-4992-833d-9df6607b1f11"
        }
      },
      "productUrl": "https://dev.eclear-solutions.com/ec-productrepo-be/products/global/pid-12345"
    },
    {
      "detail": "Small",
      "productId": "pid-67890",
      "shopIds": [
        103,
        104
      ],
      "productName": "Samsung Galaxy Tab S7 FE, 12,4 Zoll, 64 GB interner Speicher,  4 GB RAM, Wi-Fi, Android Tablet inklusive S pen, Mystic Black\n",
      "productDescription": "Genieße die brillanten Farben des 31,50 cm / 12,4-Zoll-Displays*  des Galaxy Tab S7 FE Wi-Fi. Der lebendige Bildschirm lässt Details  erstrahlen, und das Kinoerlebnis wird durch den unglaublichen Sound  by AKG verstärkt. Ausgestattet mit einem leistungsstarken Snapdragon  750G Chipset sorgt das Galaxy Tab S7 FE Wi-Fi für flüssiges und  schnelles Streaming und Gaming. Du kannst mühelos Multitasking betreiben  und bis zu drei Apps auf einmal starten Stunde um Stunde vergeht, bevor  du den 10.090 mAh-Akku** (typisch) aufladen musst. Beim Anschauen von  Videos hält er bis zu 13 Stunden durch, sodass du genug Zeit für einen  Serienmarathon hast. Der mitgelieferte S Pen mit niedriger Latenz bietet  ein weiches Schreibgefühl. Mehr: In Echtzeit wandelt er Hand-in  Druckschrift und du kannst Text einfach bearbeiten, dann legst du ihn  an der Magnethalterungab, sodass er sich selbst auflädt. Tauche in die  Farbpracht des 31, 50 cm / 12, 4 Displays* des Galaxy Tab S7 FE Wi-Fi |  Tab S7 FE 5G ein. Erlebe aufregende Film-Momente mit Sound by AKG und  freue dich auf ein farbenfrohes Display, das jede Menge Details förmlich  zum Leben erweckt. Die Dual-Lautsprecher und Dolby Atmos können außerdem  für einen raumfüllenden Surround Sound sorgen, sodass du das Gefühl hast,  mitten im Geschehen zu sein.\n",
      "subscribedEclearServices": {
        "clearVat": {
          "productClassCode": "5678901",
          "assignmentStatus": "ASSIGNED",
          "assignmentVersion": 2,
          "validFrom": "2023-02-01T00:00:00Z",
          "assignmentStrategy": "UUID",
          "actionReason": "Update for new version",
          "autoAssignmentStatus": "DONE",
          "fixedWidthProductClass": "5678901000",
          "eclearCode": "5678901000-00-000",
          "isEndNode": true,
          "assignmentUrl": "https://dev.eclear-solutions.com/ec-productassignment-be/assignments/TARIC/5a76f2d5-7684-46f4-9690-ce58ee58d629",
          "assignmentUuid": "5a76f2d5-7684-46f4-9690-ce58ee58d629"
        }
      },
      "productURL": "https://dev.eclear-solutions.com/ec-productrepo-be/products/local/pid-67890"
    }
  ],
  "links": {
    "prev": "url_for_the_previous_page",
    "next": "url_for_the_next_page"
  },
  "meta": {
    "totalCount": 1200,
    "filteredCount": 230
  }
}
{
  "code": "BadRequest",
  "message": "Bad request.",
  "status": "BAD_REQUEST"
}
{
  "code": "Unauthorized",
  "message": "Not authorized.",
  "status": "UNAUTHORIZED"
}
{
  "code": "Forbidden",
  "message": "API key no longer has access to the account, or their user level doesn’t allow access to the endpoint.",
  "status": "FORBIDDEN"
}
{
  "code": "NotFound",
  "message": "The requested resource could not be found. Either no object exists with the ID provided in the path, or the path is incorrect.",
  "status": "NOT_FOUND"
}

Assignment

Previous Page

Update the assignment PATCH

Next Page