Inventory

$inventoryApi = $client->getInventoryApi();

Class Name

InventoryApi

Methods

Deprecated Retrieve Inventory Adjustment
Retrieve Inventory Adjustment
Deprecated Batch Change Inventory
Deprecated Batch Retrieve Inventory Changes
Deprecated Batch Retrieve Inventory Counts
Batch Change Inventory
Batch Retrieve Inventory Changes
Batch Retrieve Inventory Counts
Deprecated Retrieve Inventory Physical Count
Retrieve Inventory Physical Count
Retrieve Inventory Transfer
Retrieve Inventory Count
Retrieve Inventory Changes

Deprecated Retrieve Inventory Adjustment

This endpoint is deprecated.

Deprecated version of RetrieveInventoryAdjustment after the endpoint URL is updated to conform to the standard convention.

function deprecatedRetrieveInventoryAdjustment(string $adjustmentId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`adjustmentId`	`string`	Template, Required	ID of the InventoryAdjustment to retrieve.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveInventoryAdjustmentResponse.

Example Usage

$adjustmentId = 'adjustment_id0';

$apiResponse = $inventoryApi->deprecatedRetrieveInventoryAdjustment($adjustmentId);

if ($apiResponse->isSuccess()) {
    $retrieveInventoryAdjustmentResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Retrieve Inventory Adjustment

Returns the InventoryAdjustment object with the provided adjustment_id.

function retrieveInventoryAdjustment(string $adjustmentId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`adjustmentId`	`string`	Template, Required	ID of the InventoryAdjustment to retrieve.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveInventoryAdjustmentResponse.

Example Usage

$adjustmentId = 'adjustment_id0';

$apiResponse = $inventoryApi->retrieveInventoryAdjustment($adjustmentId);

if ($apiResponse->isSuccess()) {
    $retrieveInventoryAdjustmentResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Deprecated Batch Change Inventory

This endpoint is deprecated.

Deprecated version of BatchChangeInventory after the endpoint URL is updated to conform to the standard convention.

function deprecatedBatchChangeInventory(BatchChangeInventoryRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`BatchChangeInventoryRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type BatchChangeInventoryResponse.

Example Usage

$body = BatchChangeInventoryRequestBuilder::init(
    '8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe'
)
    ->changes(
        [
            InventoryChangeBuilder::init()
                ->type(InventoryChangeType::PHYSICAL_COUNT)
                ->physicalCount(
                    InventoryPhysicalCountBuilder::init()
                        ->referenceId('1536bfbf-efed-48bf-b17d-a197141b2a92')
                        ->catalogObjectId('W62UWFY35CWMYGVWK6TWJDNI')
                        ->state(InventoryState::IN_STOCK)
                        ->locationId('C6W5YS5QM06F5')
                        ->quantity('53')
                        ->teamMemberId('LRK57NSQ5X7PUD05')
                        ->occurredAt('2016-11-16T22:25:24.878Z')
                        ->build()
                )
                ->build()
        ]
    )
    ->ignoreUnchangedCounts(true)
    ->build();

$apiResponse = $inventoryApi->deprecatedBatchChangeInventory($body);

if ($apiResponse->isSuccess()) {
    $batchChangeInventoryResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Deprecated Batch Retrieve Inventory Changes

This endpoint is deprecated.

Deprecated version of BatchRetrieveInventoryChanges after the endpoint URL is updated to conform to the standard convention.

function deprecatedBatchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`BatchRetrieveInventoryChangesRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type BatchRetrieveInventoryChangesResponse.

Example Usage

$body = BatchRetrieveInventoryChangesRequestBuilder::init()
    ->catalogObjectIds(
        [
            'W62UWFY35CWMYGVWK6TWJDNI'
        ]
    )
    ->locationIds(
        [
            'C6W5YS5QM06F5'
        ]
    )
    ->types(
        [
            InventoryChangeType::PHYSICAL_COUNT
        ]
    )
    ->states(
        [
            InventoryState::IN_STOCK
        ]
    )
    ->updatedAfter('2016-11-01T00:00:00.000Z')
    ->updatedBefore('2016-12-01T00:00:00.000Z')
    ->build();

$apiResponse = $inventoryApi->deprecatedBatchRetrieveInventoryChanges($body);

if ($apiResponse->isSuccess()) {
    $batchRetrieveInventoryChangesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Deprecated Batch Retrieve Inventory Counts

This endpoint is deprecated.

Deprecated version of BatchRetrieveInventoryCounts after the endpoint URL is updated to conform to the standard convention.

function deprecatedBatchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`BatchRetrieveInventoryCountsRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type BatchRetrieveInventoryCountsResponse.

Example Usage

$body = BatchRetrieveInventoryCountsRequestBuilder::init()
    ->catalogObjectIds(
        [
            'W62UWFY35CWMYGVWK6TWJDNI'
        ]
    )
    ->locationIds(
        [
            '59TNP9SA8VGDA'
        ]
    )
    ->updatedAfter('2016-11-16T00:00:00.000Z')
    ->build();

$apiResponse = $inventoryApi->deprecatedBatchRetrieveInventoryCounts($body);

if ($apiResponse->isSuccess()) {
    $batchRetrieveInventoryCountsResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Batch Change Inventory

Applies adjustments and counts to the provided item quantities.

On success: returns the current calculated counts for all objects referenced in the request. On failure: returns a list of related errors.

function batchChangeInventory(BatchChangeInventoryRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`BatchChangeInventoryRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type BatchChangeInventoryResponse.

Example Usage

$body = BatchChangeInventoryRequestBuilder::init(
    '8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe'
)
    ->changes(
        [
            InventoryChangeBuilder::init()
                ->type(InventoryChangeType::PHYSICAL_COUNT)
                ->physicalCount(
                    InventoryPhysicalCountBuilder::init()
                        ->referenceId('1536bfbf-efed-48bf-b17d-a197141b2a92')
                        ->catalogObjectId('W62UWFY35CWMYGVWK6TWJDNI')
                        ->state(InventoryState::IN_STOCK)
                        ->locationId('C6W5YS5QM06F5')
                        ->quantity('53')
                        ->teamMemberId('LRK57NSQ5X7PUD05')
                        ->occurredAt('2016-11-16T22:25:24.878Z')
                        ->build()
                )
                ->build()
        ]
    )
    ->ignoreUnchangedCounts(true)
    ->build();

$apiResponse = $inventoryApi->batchChangeInventory($body);

if ($apiResponse->isSuccess()) {
    $batchChangeInventoryResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Batch Retrieve Inventory Changes

Returns historical physical counts and adjustments based on the provided filter criteria.

Results are paginated and sorted in ascending order according their occurred_at timestamp (oldest first).

BatchRetrieveInventoryChanges is a catch-all query endpoint for queries that cannot be handled by other, simpler endpoints.

function batchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`BatchRetrieveInventoryChangesRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type BatchRetrieveInventoryChangesResponse.

Example Usage

$body = BatchRetrieveInventoryChangesRequestBuilder::init()
    ->catalogObjectIds(
        [
            'W62UWFY35CWMYGVWK6TWJDNI'
        ]
    )
    ->locationIds(
        [
            'C6W5YS5QM06F5'
        ]
    )
    ->types(
        [
            InventoryChangeType::PHYSICAL_COUNT
        ]
    )
    ->states(
        [
            InventoryState::IN_STOCK
        ]
    )
    ->updatedAfter('2016-11-01T00:00:00.000Z')
    ->updatedBefore('2016-12-01T00:00:00.000Z')
    ->build();

$apiResponse = $inventoryApi->batchRetrieveInventoryChanges($body);

if ($apiResponse->isSuccess()) {
    $batchRetrieveInventoryChangesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Batch Retrieve Inventory Counts

Returns current counts for the provided CatalogObjects at the requested Locations.

Results are paginated and sorted in descending order according to their calculated_at timestamp (newest first).

When updated_after is specified, only counts that have changed since that time (based on the server timestamp for the most recent change) are returned. This allows clients to perform a "sync" operation, for example in response to receiving a Webhook notification.

function batchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest $body): ApiResponse

Parameters

Parameter	Type	Tags	Description
`body`	`BatchRetrieveInventoryCountsRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type BatchRetrieveInventoryCountsResponse.

Example Usage

$body = BatchRetrieveInventoryCountsRequestBuilder::init()
    ->catalogObjectIds(
        [
            'W62UWFY35CWMYGVWK6TWJDNI'
        ]
    )
    ->locationIds(
        [
            '59TNP9SA8VGDA'
        ]
    )
    ->updatedAfter('2016-11-16T00:00:00.000Z')
    ->build();

$apiResponse = $inventoryApi->batchRetrieveInventoryCounts($body);

if ($apiResponse->isSuccess()) {
    $batchRetrieveInventoryCountsResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Deprecated Retrieve Inventory Physical Count

This endpoint is deprecated.

Deprecated version of RetrieveInventoryPhysicalCount after the endpoint URL is updated to conform to the standard convention.

function deprecatedRetrieveInventoryPhysicalCount(string $physicalCountId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`physicalCountId`	`string`	Template, Required	ID of the InventoryPhysicalCount to retrieve.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveInventoryPhysicalCountResponse.

Example Usage

$physicalCountId = 'physical_count_id2';

$apiResponse = $inventoryApi->deprecatedRetrieveInventoryPhysicalCount($physicalCountId);

if ($apiResponse->isSuccess()) {
    $retrieveInventoryPhysicalCountResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Retrieve Inventory Physical Count

Returns the InventoryPhysicalCount object with the provided physical_count_id.

function retrieveInventoryPhysicalCount(string $physicalCountId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`physicalCountId`	`string`	Template, Required	ID of the InventoryPhysicalCount to retrieve.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveInventoryPhysicalCountResponse.

Example Usage

$physicalCountId = 'physical_count_id2';

$apiResponse = $inventoryApi->retrieveInventoryPhysicalCount($physicalCountId);

if ($apiResponse->isSuccess()) {
    $retrieveInventoryPhysicalCountResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Retrieve Inventory Transfer

Returns the InventoryTransfer object with the provided transfer_id.

function retrieveInventoryTransfer(string $transferId): ApiResponse

Parameters

Parameter	Type	Tags	Description
`transferId`	`string`	Template, Required	ID of the InventoryTransfer to retrieve.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveInventoryTransferResponse.

Example Usage

$transferId = 'transfer_id6';

$apiResponse = $inventoryApi->retrieveInventoryTransfer($transferId);

if ($apiResponse->isSuccess()) {
    $retrieveInventoryTransferResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Retrieve Inventory Count

Retrieves the current calculated stock count for a given CatalogObject at a given set of Locations. Responses are paginated and unsorted. For more sophisticated queries, use a batch endpoint.

function retrieveInventoryCount(
    string $catalogObjectId,
    ?string $locationIds = null,
    ?string $cursor = null
): ApiResponse

Parameters

Parameter	Type	Tags	Description
`catalogObjectId`	`string`	Template, Required	ID of the CatalogObject to retrieve.
`locationIds`	`?string`	Query, Optional	The Location IDs to look up as a comma-separated list. An empty list queries all locations.
`cursor`	`?string`	Query, Optional	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the Pagination guide for more information.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveInventoryCountResponse.

Example Usage

$catalogObjectId = 'catalog_object_id6';

$apiResponse = $inventoryApi->retrieveInventoryCount($catalogObjectId);

if ($apiResponse->isSuccess()) {
    $retrieveInventoryCountResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Retrieve Inventory Changes

This endpoint is deprecated.

Returns a set of physical counts and inventory adjustments for the provided CatalogObject at the requested Locations.

You can achieve the same result by calling BatchRetrieveInventoryChanges and having the catalog_object_ids list contain a single element of the CatalogObject ID.

Results are paginated and sorted in descending order according to their occurred_at timestamp (newest first).

There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint.

function retrieveInventoryChanges(
    string $catalogObjectId,
    ?string $locationIds = null,
    ?string $cursor = null
): ApiResponse

Parameters

Parameter	Type	Tags	Description
`catalogObjectId`	`string`	Template, Required	ID of the CatalogObject to retrieve.
`locationIds`	`?string`	Query, Optional	The Location IDs to look up as a comma-separated list. An empty list queries all locations.
`cursor`	`?string`	Query, Optional	A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the Pagination guide for more information.

Response Type

This method returns a Square\Utils\ApiResponse instance. The getResult() method on this instance returns the response data which is of type RetrieveInventoryChangesResponse.

Example Usage

$catalogObjectId = 'catalog_object_id6';

$apiResponse = $inventoryApi->retrieveInventoryChanges($catalogObjectId);

if ($apiResponse->isSuccess()) {
    $retrieveInventoryChangesResponse = $apiResponse->getResult();
} else {
    $errors = $apiResponse->getErrors();
}

// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());

Files

inventory.md

Latest commit

History

inventory.md

File metadata and controls

Inventory

Class Name

Methods

Deprecated Retrieve Inventory Adjustment

Parameters

Response Type

Example Usage

Retrieve Inventory Adjustment

Parameters

Response Type

Example Usage

Deprecated Batch Change Inventory

Parameters

Response Type

Example Usage

Deprecated Batch Retrieve Inventory Changes

Parameters

Response Type

Example Usage

Deprecated Batch Retrieve Inventory Counts

Parameters

Response Type

Example Usage

Batch Change Inventory

Parameters

Response Type

Example Usage

Batch Retrieve Inventory Changes

Parameters

Response Type

Example Usage

Batch Retrieve Inventory Counts

Parameters

Response Type

Example Usage

Deprecated Retrieve Inventory Physical Count

Parameters

Response Type

Example Usage

Retrieve Inventory Physical Count

Parameters

Response Type

Example Usage

Retrieve Inventory Transfer

Parameters

Response Type

Example Usage

Retrieve Inventory Count

Parameters

Response Type

Example Usage

Retrieve Inventory Changes

Parameters

Response Type

Example Usage