Packaging Units (DOMS)

Endpoints for managing packaging units.

Get all PackagingUnits details

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successfully retrieved the PackagingUnits.

No content

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

The requested entity was not found

application/json

get/api/packagingunits

HTTPcURLJavaScriptPython

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

No content

Create a PackagingUnitDetail by its ID

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

PackagingUnitDetailForCreation

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

carrierRefstringRequired

The reference to the carrier associated with the packagingUnit.

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

detailsany ofRequired

or

or

or

tenantPackagingUnitIdstringRequired

The tenant specific identifier for the packagingUnit.

Example: MY_PACKAGINGUNIT_ID

Responses

200

Successfully created the PackagingUnitDetail.

No content

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

The requested entity was not found

application/json

post/api/packagingunits

HTTPcURLJavaScriptPython

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

{
  "nameLocalized": {},
  "carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "details": {
    "dimensions": {
      "maxHeight": 1,
      "maxLength": 1,
      "maxWidth": 1
    },
    "maxItemQuantity": 1,
    "maxWeight": 1,
    "packagingPricingDetails": {
      "costCoefficient": {
        "measurementUnit": "GRAM",
        "value": {
          "currency": "text",
          "decimalPlaces": 2,
          "value": 1
        }
      },
      "pricing": [
        {
          "overflowFactor": {
            "factor": 1,
            "price": {
              "currency": "text",
              "decimalPlaces": 2,
              "value": 1
            }
          },
          "prices": [
            {
              "price": {
                "currency": "text",
                "decimalPlaces": 2,
                "value": 1
              },
              "upperThreshold": 1
            }
          ],
          "zone": "text"
        }
      ],
      "surchargesPerPackagingUnits": [
        {
          "percentage": 1,
          "tenantSurchargeType": "text",
          "type": "ABSOLUTE_SURCHARGE_TYPE"
        }
      ]
    },
    "type": "PALLET",
    "volumeBufferInPercent": 1,
    "volumetricWeightFactor": 1
  },
  "tenantPackagingUnitId": "MY_PACKAGINGUNIT_ID"
}

No content

Get a PackagingUnits by its ID

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Retrieves a single PackagingUnit using its unique identifier.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Successfully retrieved the PackagingUnit.

No content

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

The requested entity was not found

application/json

get/api/packagingunits/{id}

HTTPcURLJavaScriptPython

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

No content

Updates a whole packagingUnitDetail by its ID

put

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

application/json

PackagingUnitDetailForUpdate

nameLocalizedobject · LocaleStringConstrainedRequired

LocaleStringConstrained

carrierRefstringRequired

The reference to the carrier associated with the packagingUnit.

Example: 0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f

detailsany ofRequired

or

or

or

tenantPackagingUnitIdstringRequired

The tenant specific identifier for the packagingUnit.

Example: MY_PACKAGINGUNIT_ID

versionnumberRequired

The version of the packagingUnit.

Example: 1

Responses

200

Successfully updated the packagingUnitDetail.

No content

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

The requested entity was not found

application/json

put/api/packagingunits/{id}

HTTPcURLJavaScriptPython

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

{
  "nameLocalized": {},
  "carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
  "details": {
    "dimensions": {
      "maxHeight": 1,
      "maxLength": 1,
      "maxWidth": 1
    },
    "maxItemQuantity": 1,
    "maxWeight": 1,
    "packagingPricingDetails": {
      "costCoefficient": {
        "measurementUnit": "GRAM",
        "value": {
          "currency": "text",
          "decimalPlaces": 2,
          "value": 1
        }
      },
      "pricing": [
        {
          "overflowFactor": {
            "factor": 1,
            "price": {
              "currency": "text",
              "decimalPlaces": 2,
              "value": 1
            }
          },
          "prices": [
            {
              "price": {
                "currency": "text",
                "decimalPlaces": 2,
                "value": 1
              },
              "upperThreshold": 1
            }
          ],
          "zone": "text"
        }
      ],
      "surchargesPerPackagingUnits": [
        {
          "percentage": 1,
          "tenantSurchargeType": "text",
          "type": "ABSOLUTE_SURCHARGE_TYPE"
        }
      ]
    },
    "type": "PALLET",
    "volumeBufferInPercent": 1,
    "volumetricWeightFactor": 1
  },
  "tenantPackagingUnitId": "MY_PACKAGINGUNIT_ID",
  "version": 1
}

No content

Delete a PackagingUnitDetail by its ID

delete

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Deletes a single PackagingUnitDetail using its unique identifier.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200

Successfully deleted the PackagingUnit.

No content

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

The requested entity was not found

application/json

delete/api/packagingunits/{id}

HTTPcURLJavaScriptPython

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

No content