mutation · Module: Trade · Requires trade:write
Arguments
| Argument | Type | Description |
|---|---|---|
input | ClassificationCreate | The fields for this operation. |
ClassificationCreate fields
| Field | Type |
|---|---|
items | [ItemInput!] |
export_country | String |
import_countries | [String!] |
include_restrictions | Boolean |
user_metadata | UserMetadataInput |
Returns
Classification!
| Field | Type |
|---|---|
id | String! |
object | ClassificationObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
status | ClassificationStatus! |
items | [ClassificationItemsItem!]! |
messages | [Message!] |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation CreateClassification($input: ClassificationCreate!) {
createClassification(input: $input) {
id
object
status
livemode
created
updated
items {
index
sku
export {
country
hs_code
description
confidence
}
import {
country
hs_code
description
confidence
}
requires_review
rationale
}
messages {
code
level
message
param
carrier
}
}
}
{
"input": {
"items": [
{
"title": "Example",
"description": "Example description",
"sku": "TS-RED-M",
"quantity": 2
}
],
"export_country": "GB",
"import_countries": [
"example"
],
"include_restrictions": true
}
}
{
"data": {
"createClassification": {
"id": "cls_1a2B3c",
"object": "classification",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"items": [
{
"index": 2,
"sku": "TS-RED-M",
"export": {
"country": "GB",
"hs_code": "6109100010",
"description": "Example description",
"confidence": 0.94
},
"import": [
{
"country": "GB",
"hs_code": "6109100010",
"description": "Example description",
"confidence": 0.94
}
],
"requires_review": true,
"rationale": "example"
}
],
"messages": [
{
"code": "dhl_express_worldwide",
"level": "info",
"message": "example",
"param": "example",
"carrier": "dhl_express"
}
]
}
}
}