Metadata [Dictionary]

Get all metadata prototypes.

get

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

scopestring · enumOptional

Metadata prototype scope.

Possible values:

modestring · enumOptional

Metadata prototype mode.

Possible values:

Header parameters

X-Account-IDintegerOptional

Account identifier

Responses

200

OK

application/json

Array of metadata prototypes.

idintegerOptional

Metadata prototype id

Example: 1

namestringOptional

Metadata prototype name

Example: Customs Clearance

formatstringOptional

Metadata prototype format

Example: alpha;20

scopestringOptional

Metadata prototype scopes

Example: quotes

for_airbooleanOptional

Allowed for mode air

Example: true

for_seabooleanOptional

Allowed for mode sea

Example: true

for_roadbooleanOptional

Allowed for mode road

Example: true

for_railbooleanOptional

Allowed for mode rail

Example: true

for_expressbooleanOptional

Allowed for mode express

Example: true

for_groupagebooleanOptional

Allowed for mode groupage

Example: true

for_courierbooleanOptional

Allowed for mode courier

Example: true

for_air_seabooleanOptional

Allowed for mode air-sea

Example: true

401

Unauthorized

application/json

500

Internal Error

application/json

get

/dictionary/metadata-prototypes

HTTPcURLJavaScriptPython

GET /dictionary/metadata-prototypes HTTP/1.1
Host: api.shiptify.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "Customs Clearance",
    "format": "alpha;20",
    "scope": "quotes",
    "for_air": "true",
    "for_sea": "true",
    "for_road": "true",
    "for_rail": "true",
    "for_express": "true",
    "for_groupage": "true",
    "for_courier": "true",
    "for_air_sea": "true"
  }
]