AlphaAlpha Docs
API Reference

Picklists

API calls concerning picklists

Find all

GET
/finance/picklists

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/finance/picklists"
[
  {
    "acceptedReturns": [
      {
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "checker": "string",
    "checkingNote": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deadline": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCancellable": true,
    "isPicked": true,
    "isReserved": true,
    "packer": "string",
    "picker": "string",
    "picklistType": "ORDER",
    "priority": "LOW_PRIORITY",
    "products": [
      {
        "checked": true,
        "markedForReturn": true,
        "packed": true,
        "picked": true,
        "pickedStockBatches": [
          {
            "batchNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "originalPurchaseOrderId": "string",
            "price": 0.1,
            "productId": "string",
            "productionDate": "2019-08-24T14:15:22Z",
            "quantity": 0.1
          }
        ],
        "productId": "string",
        "quantity": 0.1,
        "quantityToReturn": 0.1
      }
    ],
    "rejectedReturns": [
      {
        "batches": [
          {
            "quantity": 0.1,
            "reason": "string"
          }
        ],
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "returnCompletedAt": "2019-08-24T14:15:22Z",
    "returnDeadline": "2019-08-24T14:15:22Z",
    "shipment": {
      "courier": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "destinationAddress": "string",
      "dimensions": "string",
      "labelHasBeenPrinted": true,
      "packingNote": "string",
      "shippingDate": "2019-08-24T14:15:22Z",
      "shippingMethod": "string",
      "shippingNote": "string",
      "stockSiteAddress": "string",
      "trackingNumber": "string",
      "trackingUrl": "string",
      "weight": "string"
    },
    "sourceId": "string",
    "status": "READY_TO_PICK",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalReturned": [
      {
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by list of ids

DELETE
/finance/picklists

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/finance/picklists" \  -H "Content-Type: application/json" \  -d '[    "string"  ]'
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids

GET
/finance/picklists/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/finance/picklists/find?ids=string"
[
  {
    "acceptedReturns": [
      {
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "checker": "string",
    "checkingNote": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "deadline": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isCancellable": true,
    "isPicked": true,
    "isReserved": true,
    "packer": "string",
    "picker": "string",
    "picklistType": "ORDER",
    "priority": "LOW_PRIORITY",
    "products": [
      {
        "checked": true,
        "markedForReturn": true,
        "packed": true,
        "picked": true,
        "pickedStockBatches": [
          {
            "batchNumber": "string",
            "expirationDate": "2019-08-24T14:15:22Z",
            "originalPurchaseOrderId": "string",
            "price": 0.1,
            "productId": "string",
            "productionDate": "2019-08-24T14:15:22Z",
            "quantity": 0.1
          }
        ],
        "productId": "string",
        "quantity": 0.1,
        "quantityToReturn": 0.1
      }
    ],
    "rejectedReturns": [
      {
        "batches": [
          {
            "quantity": 0.1,
            "reason": "string"
          }
        ],
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "returnCompletedAt": "2019-08-24T14:15:22Z",
    "returnDeadline": "2019-08-24T14:15:22Z",
    "shipment": {
      "courier": "string",
      "deliveryDate": "2019-08-24T14:15:22Z",
      "destinationAddress": "string",
      "dimensions": "string",
      "labelHasBeenPrinted": true,
      "packingNote": "string",
      "shippingDate": "2019-08-24T14:15:22Z",
      "shippingMethod": "string",
      "shippingNote": "string",
      "stockSiteAddress": "string",
      "trackingNumber": "string",
      "trackingUrl": "string",
      "weight": "string"
    },
    "sourceId": "string",
    "status": "READY_TO_PICK",
    "stockSiteId": "string",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalReturned": [
      {
        "productId": "string",
        "quantity": 0.1
      }
    ],
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id

GET
/finance/picklists/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/finance/picklists/find/string"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isCancellable": true,
  "isPicked": true,
  "isReserved": true,
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "pickedStockBatches": [
        {
          "batchNumber": "string",
          "expirationDate": "2019-08-24T14:15:22Z",
          "originalPurchaseOrderId": "string",
          "price": 0.1,
          "productId": "string",
          "productionDate": "2019-08-24T14:15:22Z",
          "quantity": 0.1
        }
      ],
      "productId": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalReturned": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/finance/picklists/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/finance/picklists/page"
{
  "content": [
    {
      "acceptedReturns": [
        {
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "checker": "string",
      "checkingNote": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "deadline": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isCancellable": true,
      "isPicked": true,
      "isReserved": true,
      "packer": "string",
      "picker": "string",
      "picklistType": "ORDER",
      "priority": "LOW_PRIORITY",
      "products": [
        {
          "checked": true,
          "markedForReturn": true,
          "packed": true,
          "picked": true,
          "pickedStockBatches": [
            {
              "batchNumber": "string",
              "expirationDate": "2019-08-24T14:15:22Z",
              "originalPurchaseOrderId": "string",
              "price": 0.1,
              "productId": "string",
              "productionDate": "2019-08-24T14:15:22Z",
              "quantity": 0.1
            }
          ],
          "productId": "string",
          "quantity": 0.1,
          "quantityToReturn": 0.1
        }
      ],
      "rejectedReturns": [
        {
          "batches": [
            {
              "quantity": 0.1,
              "reason": "string"
            }
          ],
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "returnCompletedAt": "2019-08-24T14:15:22Z",
      "returnDeadline": "2019-08-24T14:15:22Z",
      "shipment": {
        "courier": "string",
        "deliveryDate": "2019-08-24T14:15:22Z",
        "destinationAddress": "string",
        "dimensions": "string",
        "labelHasBeenPrinted": true,
        "packingNote": "string",
        "shippingDate": "2019-08-24T14:15:22Z",
        "shippingMethod": "string",
        "shippingNote": "string",
        "stockSiteAddress": "string",
        "trackingNumber": "string",
        "trackingUrl": "string",
        "weight": "string"
      },
      "sourceId": "string",
      "status": "READY_TO_PICK",
      "stockSiteId": "string",
      "subsidiaryId": "string",
      "tenantId": "string",
      "totalReturned": [
        {
          "productId": "string",
          "quantity": 0.1
        }
      ],
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get picklist stats

GET
/finance/picklists/stats

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/finance/picklists/stats"
{
  "groupedStatuses": {
    "property1": 0,
    "property2": 0
  },
  "percentagePicked": 0.1,
  "total": 0,
  "totalHighPriority": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get enriched picklist

GET
/finance/picklists/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/finance/picklists/string"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id

DELETE
/finance/picklists/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/finance/picklists/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Assign checker to picklist

PATCH
/finance/picklists/{id}/assign/checker/{user}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
user*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/assign/checker/string"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Assign packer to picklist

PATCH
/finance/picklists/{id}/assign/packer/{user}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
user*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/assign/packer/string"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Assign picker to picklist

PATCH
/finance/picklists/{id}/assign/picker/{user}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
user*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/assign/picker/string"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel a picklist

PATCH
/finance/picklists/{id}/cancel

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/cancel"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Fail a check for picklist

PATCH
/finance/picklists/{id}/checks/fail

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

note*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/checks/fail?note=string"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Pass a check for picklist

PATCH
/finance/picklists/{id}/checks/pass

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/checks/pass"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Request check for picklist

PATCH
/finance/picklists/{id}/checks/request

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/checks/request"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Close a picklist

PATCH
/finance/picklists/{id}/close

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/close"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Mark a picklist as delivered

PATCH
/finance/picklists/{id}/delivered

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

date?string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/delivered"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Mark picklist as dispatched

POST
/finance/picklists/{id}/dispatch

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/finance/picklists/string/dispatch" \  -H "Content-Type: application/json" \  -d '{}'
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Generate shipping label for picklist

PATCH
/finance/picklists/{id}/generate-label

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/generate-label"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Start picking picklist

PATCH
/finance/picklists/{id}/pick

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/pick"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
POST
/finance/picklists/{id}/print-label

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/finance/picklists/string/print-label" \  -H "Content-Type: application/json" \  -d '{}'
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Ready picklist for dispatch

PATCH
/finance/picklists/{id}/ready-for-dispatch

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/ready-for-dispatch"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Remove checker from picklist

PATCH
/finance/picklists/{id}/remove/checker

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/remove/checker"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Remove packer from picklist

PATCH
/finance/picklists/{id}/remove/packer

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/remove/packer"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Remove picker from picklist

PATCH
/finance/picklists/{id}/remove/picker

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/finance/picklists/string/remove/picker"
{
  "acceptedReturns": [
    {
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "checker": "string",
  "checkingNote": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "deadline": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "packer": "string",
  "picker": "string",
  "picklistType": "ORDER",
  "priority": "LOW_PRIORITY",
  "products": [
    {
      "checked": true,
      "imageAssets": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "markedForReturn": true,
      "packed": true,
      "picked": true,
      "productId": "string",
      "productName": "string",
      "quantity": 0.1,
      "quantityToReturn": 0.1,
      "unitsOfMeasurement": [
        {
          "baseUnit": true,
          "cost": 0.1,
          "decimal": true,
          "isBaseUnit": true,
          "isDecimal": true,
          "name": "string",
          "quantity": 0.1,
          "salesPrice": 0.1,
          "unit": "string"
        }
      ]
    }
  ],
  "rejectedReturns": [
    {
      "batches": [
        {
          "quantity": 0.1,
          "reason": "string"
        }
      ],
      "productId": "string",
      "quantity": 0.1
    }
  ],
  "returnCompletedAt": "2019-08-24T14:15:22Z",
  "returnDeadline": "2019-08-24T14:15:22Z",
  "shipment": {
    "courier": "string",
    "deliveryDate": "2019-08-24T14:15:22Z",
    "destinationAddress": "string",
    "dimensions": "string",
    "labelHasBeenPrinted": true,
    "packingNote": "string",
    "shippingDate": "2019-08-24T14:15:22Z",
    "shippingMethod": "string",
    "shippingNote": "string",
    "stockSiteAddress": "string",
    "trackingNumber": "string",
    "trackingUrl": "string",
    "weight": "string"
  },
  "sourceId": "string",
  "status": "READY_TO_PICK",
  "stockSiteId": "string",
  "subsidiaryId": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Order

Previous Page

P O Approval Settings

Next Page