Ctrlk
API documentationIncident managementFeedback
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Packing Configuration (Operations)

Endpoints to create, update, and read packing configuration.

Get packing config

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Central Configuration of all packing related things

application/json

VersionedResource

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
get/api/configurations/packing
GET /api/configurations/packing HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "documentHandlingConfiguration": {
    "inheritedDocumentConfigurations": []
  },
  "packingContainerRequiredConfiguration": {
    "active": false
  },
  "packingItemConfirmationNeededConfiguration": {
    "active": true
  },
  "packingSourceContainerConfiguration": {
    "active": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_EACH"
  }
}

Update packing config

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

VersionedResource

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
Responses
200

The packing central configuration was successfully updated.

application/json

VersionedResource

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
patch/api/configurations/packing
PATCH /api/configurations/packing HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "documentHandlingConfiguration": {
    "inheritedDocumentConfigurations": []
  },
  "packingContainerRequiredConfiguration": {
    "active": false
  },
  "packingItemConfirmationNeededConfiguration": {
    "active": true
  },
  "packingSourceContainerConfiguration": {
    "active": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_EACH"
  }
}
{
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "documentHandlingConfiguration": {
    "inheritedDocumentConfigurations": []
  },
  "packingContainerRequiredConfiguration": {
    "active": false
  },
  "packingItemConfirmationNeededConfiguration": {
    "active": true
  },
  "packingSourceContainerConfiguration": {
    "active": false
  },
  "scanningConfiguration": {
    "scanningType": "MUST_SCAN_EACH"
  }
}
Deprecated

Get packing container required config

get

This part of the API is deprecated. For details, see the API release lifecycle documentation. Deprecated, replaced with /api/configurations/packing

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

The requirement of containers in packing can be found in the body.

application/json

Packing Container Required Configuration.

activebooleanRequiredDefault: false
get/api/configurations/packing/containerrequired
GET /api/configurations/packing/containerrequired HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "active": false
}
Deprecated

Update packing container required config

put

This part of the API is deprecated. For details, see the API release lifecycle documentation. Deprecated, will be replaced with /api/configurations/packing

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Packing Container Required Configuration.

activebooleanRequiredDefault: false
Responses
200

The packing container requirement configuration was successfully updated.

application/json

Packing Container Required Configuration.

activebooleanRequiredDefault: false
put/api/configurations/packing/containerrequired
PUT /api/configurations/packing/containerrequired HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "active": false
}
{
  "active": false
}

Get pack jobs tag config

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

Packjob tag config is in response body.

application/json

PackJobTagConfiguration

and
get/api/configurations/tags/packjob
GET /api/configurations/tags/packjob HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "packJobCreationPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "packJobCreationDisabled": true,
      "tagRef": "text"
    }
  ],
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  }
}

Update pack jobs tag config

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

PackJobTagConfiguration

and
Responses
200

The packing configuration was successfully updated.

application/json

PackJobTagConfiguration

and
put/api/configurations/tags/packjob
PUT /api/configurations/tags/packjob HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 604

{
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "packJobCreationPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "packJobCreationDisabled": true,
      "tagRef": "text"
    }
  ],
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  }
}
{
  "offeredDocumentsByDefault": [
    {
      "documentCategory": "EXTERNAL"
    }
  ],
  "offeredDocumentsPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "offeredDocuments": [
        {
          "documentCategory": "EXTERNAL"
        }
      ],
      "tagRef": "text"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "lineItemStickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  },
  "packJobCreationPerTag": [
    {
      "matchingValues": [
        "text"
      ],
      "packJobCreationDisabled": true,
      "tagRef": "text"
    }
  ],
  "stickerConfiguration": {
    "offeredStickersByTag": [
      {
        "matchingValues": [
          "text"
        ],
        "stickers": [],
        "tagRef": "text"
      }
    ]
  }
}

Get needs packing for tags

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
anyOptional

TagReference

Responses
200

NeedsPacking information for this tag was found & you were allowed to access it. The result is in the body.

application/json
anyOptional

NeedsPacking

post/api/tags/packing/needspacking
POST /api/tags/packing/needspacking HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

[]
[
  {
    "needsPacking": true
  }
]
PreviousPacking (Operations)
NextPicking (Operations)

Last updated

Was this helpful?