# Vend\PickListsApi



All URIs are relative to https://example.retail.lightspeed.app/api/2026-04, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**getPickListsBySaleID()**](PickListsApi.md#getPickListsBySaleID) | **GET** /sales/{sale_id}/pick_lists | List Sale Pick Lists |


## `getPickListsBySaleID()`

```php
getPickListsBySaleID($sale_id): \Vend\Model\PickListsResponse
```

List Sale Pick Lists

Returns a list of pick lists for a given sale.  🔒 Requires: `sales:read` scope

### Example

```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer authorization: bearerAuth
$config = Vend\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Vend\Api\PickListsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sale_id = 'sale_id_example'; // string | The sale id

try {
    $result = $apiInstance->getPickListsBySaleID($sale_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PickListsApi->getPickListsBySaleID: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **sale_id** | **string**| The sale id | |

### Return type

[**\Vend\Model\PickListsResponse**](../Model/PickListsResponse.md)

### Authorization

[bearerAuth](../../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
