Measurement units endpoints

List measurement units

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of measurementUnits to show

Default: 25

keystringOptional

key of the measurementUnit

localestringOptional

Provide the localized names for the measurementUnit. If not provided the default locale is used., for example de_DE.

Responses

200

The found measurementUnit.

application/json

MeasurementUnits

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get/api/measurementunits

GET /api/measurementunits HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "measurementUnits": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "abbreviationLocalized": {
        "de_DE": "kg",
        "en_US": "kg",
        "ru_RU": "кг"
      },
      "key": "kilogramm",
      "requiresMeasurement": true,
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Get measurement unit

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

measurementUnitIdstringRequired

Responses

200

The found measurementUnit.

application/json

MeasurementUnit

keystringRequired

Descriptor for the measurement unit

Example: kilogramm

requiresMeasurementbooleanOptional

Indicates that the given unit need to be measured.

Example: true

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

abbreviationstringOptional

Translated abbreviation of the measurement unit

Example: kg

idstringRequiredExample: c5300790-9477-475c-bd6d-98e5d61f6413

namestringOptional

Translated name of the measurement unit

Example: kilogramm

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get/api/measurementunits/{measurementUnitId}

GET /api/measurementunits/{measurementUnitId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "abbreviation": "kg",
  "id": "c5300790-9477-475c-bd6d-98e5d61f6413",
  "name": "kilogramm",
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "abbreviationLocalized": {
    "de_DE": "kg",
    "en_US": "kg",
    "ru_RU": "кг"
  },
  "key": "kilogramm",
  "requiresMeasurement": true,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Create measurement unit

post

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

MeasurementUnitForCreation

keystringRequired

Descriptor for the measurement unit

Example: kilogramm

requiresMeasurementbooleanOptional

Indicates that the given unit need to be measured.

Example: true

Responses

201

Successfully created the measurementUnit.

application/json

MeasurementUnit

keystringRequired

Descriptor for the measurement unit

Example: kilogramm

requiresMeasurementbooleanOptional

Indicates that the given unit need to be measured.

Example: true

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

abbreviationstringOptional

Translated abbreviation of the measurement unit

Example: kg

idstringRequiredExample: c5300790-9477-475c-bd6d-98e5d61f6413

namestringOptional

Translated name of the measurement unit

Example: kilogramm

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

post/api/measurementunits

POST /api/measurementunits HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "abbreviationLocalized": {
    "de_DE": "kg",
    "en_US": "kg",
    "ru_RU": "кг"
  },
  "key": "kilogramm",
  "requiresMeasurement": true
}

{
  "abbreviation": "kg",
  "id": "c5300790-9477-475c-bd6d-98e5d61f6413",
  "name": "kilogramm",
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "abbreviationLocalized": {
    "de_DE": "kg",
    "en_US": "kg",
    "ru_RU": "кг"
  },
  "key": "kilogramm",
  "requiresMeasurement": true,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update measurement unit

put

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

measurementUnitIdstringRequired

Body

MeasurementUnitForCreation

keystringRequired

Descriptor for the measurement unit

Example: kilogramm

requiresMeasurementbooleanOptional

Indicates that the given unit need to be measured.

Example: true

Responses

200

Successfully updated the measurementUnit.

application/json

MeasurementUnit

keystringRequired

Descriptor for the measurement unit

Example: kilogramm

requiresMeasurementbooleanOptional

Indicates that the given unit need to be measured.

Example: true

createdstring · date-timeOptional

The date this entity was created at the platform. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

abbreviationstringOptional

Translated abbreviation of the measurement unit

Example: kg

idstringRequiredExample: c5300790-9477-475c-bd6d-98e5d61f6413

namestringOptional

Translated name of the measurement unit

Example: kilogramm

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

put/api/measurementunits/{measurementUnitId}

PUT /api/measurementunits/{measurementUnitId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "abbreviationLocalized": {
    "de_DE": "kg",
    "en_US": "kg",
    "ru_RU": "кг"
  },
  "key": "kilogramm",
  "requiresMeasurement": true
}

{
  "abbreviation": "kg",
  "id": "c5300790-9477-475c-bd6d-98e5d61f6413",
  "name": "kilogramm",
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "abbreviationLocalized": {
    "de_DE": "kg",
    "en_US": "kg",
    "ru_RU": "кг"
  },
  "key": "kilogramm",
  "requiresMeasurement": true,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete measurement unit

delete

This part of the API is in Beta status. For details, see the API release lifecycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

measurementUnitIdstringRequired

Responses

200

Successfully deleted the measurementUnit.

No content

401

Your user is not allowed to operate against this API instance

*/*

403

Your user, although recognized, is not authorized to use this endpoint

*/*

404

Entity not found

*/*

delete/api/measurementunits/{measurementUnitId}

DELETE /api/measurementunits/{measurementUnitId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated 5 months ago