SquareConnect\CatalogApi

All URIs are relative to https://connect.squareup.com

Method	HTTP request	Description
batchDeleteCatalogObjects	POST /v2/catalog/batch-delete	BatchDeleteCatalogObjects
batchRetrieveCatalogObjects	POST /v2/catalog/batch-retrieve	BatchRetrieveCatalogObjects
batchUpsertCatalogObjects	POST /v2/catalog/batch-upsert	BatchUpsertCatalogObjects
catalogInfo	GET /v2/catalog/info	CatalogInfo
deleteCatalogObject	DELETE /v2/catalog/object/{object_id}	DeleteCatalogObject
listCatalog	GET /v2/catalog/list	ListCatalog
retrieveCatalogObject	GET /v2/catalog/object/{object_id}	RetrieveCatalogObject
searchCatalogObjects	POST /v2/catalog/search	SearchCatalogObjects
updateItemModifierLists	POST /v2/catalog/update-item-modifier-lists	UpdateItemModifierLists
updateItemTaxes	POST /v2/catalog/update-item-taxes	UpdateItemTaxes
upsertCatalogObject	POST /v2/catalog/object	UpsertCatalogObject

batchDeleteCatalogObjects

\SquareConnect\Model\BatchDeleteCatalogObjectsResponse batchDeleteCatalogObjects($body)

BatchDeleteCatalogObjects

Deletes a set of CatalogItems based on the provided list of target IDs and returns a set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its CatalogItemVariation children. BatchDeleteCatalogObjects succeeds even if only a portion of the targeted IDs can be deleted. The response will only include IDs that were actually deleted.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\BatchDeleteCatalogObjectsRequest(); // \SquareConnect\Model\BatchDeleteCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->batchDeleteCatalogObjects($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->batchDeleteCatalogObjects: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SquareConnect\Model\BatchDeleteCatalogObjectsRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

\SquareConnect\Model\BatchDeleteCatalogObjectsResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

batchRetrieveCatalogObjects

\SquareConnect\Model\BatchRetrieveCatalogObjectsResponse batchRetrieveCatalogObjects($body)

BatchRetrieveCatalogObjects

Returns a set of objects based on the provided ID. Each CatalogItem returned in the set includes all of its child information including: all of its CatalogItemVariation objects, references to its CatalogModifierList objects, and the ids of any CatalogTax objects that apply to it.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\BatchRetrieveCatalogObjectsRequest(); // \SquareConnect\Model\BatchRetrieveCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->batchRetrieveCatalogObjects($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->batchRetrieveCatalogObjects: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SquareConnect\Model\BatchRetrieveCatalogObjectsRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

\SquareConnect\Model\BatchRetrieveCatalogObjectsResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

batchUpsertCatalogObjects

\SquareConnect\Model\BatchUpsertCatalogObjectsResponse batchUpsertCatalogObjects($body)

BatchUpsertCatalogObjects

Creates or updates up to 10,000 target objects based on the provided list of objects. The target objects are grouped into batches and each batch is inserted/updated in an all-or-nothing manner. If an object within a batch is malformed in some way, or violates a database constraint, the entire batch containing that item will be disregarded. However, other batches in the same request may still succeed. Each batch may contain up to 1,000 objects, and batches will be processed in order as long as the total object count for the request (items, variations, modifier lists, discounts, and taxes) is no more than 10,000.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\BatchUpsertCatalogObjectsRequest(); // \SquareConnect\Model\BatchUpsertCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->batchUpsertCatalogObjects($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->batchUpsertCatalogObjects: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SquareConnect\Model\BatchUpsertCatalogObjectsRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

\SquareConnect\Model\BatchUpsertCatalogObjectsResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

catalogInfo

\SquareConnect\Model\CatalogInfoResponse catalogInfo()

CatalogInfo

Returns information about the Square Catalog API, such as batch size limits for BatchUpsertCatalogObjects.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();

try {
    $result = $apiInstance->catalogInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->catalogInfo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\SquareConnect\Model\CatalogInfoResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteCatalogObject

\SquareConnect\Model\DeleteCatalogObjectResponse deleteCatalogObject($object_id)

DeleteCatalogObject

Deletes a single CatalogObject based on the provided ID and returns the set of successfully deleted IDs in the response. Deletion is a cascading event such that all children of the targeted object are also deleted. For example, deleting a CatalogItem will also delete all of its CatalogItemVariation children.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$object_id = "object_id_example"; // string | The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations).

try {
    $result = $apiInstance->deleteCatalogObject($object_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->deleteCatalogObject: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
object_id	string	The ID of the catalog object to be deleted. When an object is deleted, other objects in the graph that depend on that object will be deleted as well (for example, deleting a catalog item will delete its catalog item variations).

Return type

\SquareConnect\Model\DeleteCatalogObjectResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listCatalog

\SquareConnect\Model\ListCatalogResponse listCatalog($cursor, $types)

ListCatalog

Returns a list of CatalogObjects that includes all objects of a set of desired types (for example, all CatalogItem and CatalogTax objects) in the catalog. The types parameter is specified as a comma-separated list of valid CatalogObject types: ITEM, ITEM_VARIATION, MODIFIER, MODIFIER_LIST, CATEGORY, DISCOUNT, TAX, IMAGE. Important: ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set include_deleted_objects to true.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$cursor = "cursor_example"; // string | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information.
$types = "types_example"; // string | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`.  The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.

try {
    $result = $apiInstance->listCatalog($cursor, $types);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->listCatalog: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
cursor	string	The pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information.	[optional]
types	string	An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`. The legal values are taken from the CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.	[optional]

Return type

\SquareConnect\Model\ListCatalogResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieveCatalogObject

\SquareConnect\Model\RetrieveCatalogObjectResponse retrieveCatalogObject($object_id, $include_related_objects)

RetrieveCatalogObject

Returns a single CatalogItem as a CatalogObject based on the provided ID. The returned object includes all of the relevant CatalogItem information including: CatalogItemVariation children, references to its CatalogModifierList objects, and the ids of any CatalogTax objects that apply to it.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$object_id = "object_id_example"; // string | The object ID of any type of catalog objects to be retrieved.
$include_related_objects = true; // bool | If `true`, the response will include additional objects that are related to the requested object, as follows:  If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response.  Default value: `false`

try {
    $result = $apiInstance->retrieveCatalogObject($object_id, $include_related_objects);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->retrieveCatalogObject: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
object_id	string	The object ID of any type of catalog objects to be retrieved.
include_related_objects	bool	If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a CatalogItem, its associated CatalogCategory, CatalogTax objects, CatalogImages and CatalogModifierLists will be returned in the `related_objects` field of the response. If the `object` field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the `related_objects` field of the response. Default value: `false`	[optional]

Return type

\SquareConnect\Model\RetrieveCatalogObjectResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

searchCatalogObjects

\SquareConnect\Model\SearchCatalogObjectsResponse searchCatalogObjects($body)

SearchCatalogObjects

Queries the targeted catalog using a variety of query types: CatalogQuerySortedAttribute, CatalogQueryExact, CatalogQueryRange, CatalogQueryText, CatalogQueryItemsForTax, and CatalogQueryItemsForModifierList. -- -- Future end of the above comment: CatalogQueryItemsForTax, CatalogQueryItemsForModifierList, CatalogQueryItemsForItemOptions, and CatalogQueryItemVariationsForItemOptionValues.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\SearchCatalogObjectsRequest(); // \SquareConnect\Model\SearchCatalogObjectsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->searchCatalogObjects($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->searchCatalogObjects: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SquareConnect\Model\SearchCatalogObjectsRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

\SquareConnect\Model\SearchCatalogObjectsResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateItemModifierLists

\SquareConnect\Model\UpdateItemModifierListsResponse updateItemModifierLists($body)

UpdateItemModifierLists

Updates the CatalogModifierList objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\UpdateItemModifierListsRequest(); // \SquareConnect\Model\UpdateItemModifierListsRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->updateItemModifierLists($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->updateItemModifierLists: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SquareConnect\Model\UpdateItemModifierListsRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

\SquareConnect\Model\UpdateItemModifierListsResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateItemTaxes

\SquareConnect\Model\UpdateItemTaxesResponse updateItemTaxes($body)

UpdateItemTaxes

Updates the CatalogTax objects that apply to the targeted CatalogItem without having to perform an upsert on the entire item.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\UpdateItemTaxesRequest(); // \SquareConnect\Model\UpdateItemTaxesRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->updateItemTaxes($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->updateItemTaxes: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SquareConnect\Model\UpdateItemTaxesRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

\SquareConnect\Model\UpdateItemTaxesResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upsertCatalogObject

\SquareConnect\Model\UpsertCatalogObjectResponse upsertCatalogObject($body)

UpsertCatalogObject

Creates or updates the target CatalogObject.

Example

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

// Configure OAuth2 access token for authorization: oauth2
SquareConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new SquareConnect\Api\CatalogApi();
$body = new \SquareConnect\Model\UpsertCatalogObjectRequest(); // \SquareConnect\Model\UpsertCatalogObjectRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->upsertCatalogObject($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CatalogApi->upsertCatalogObject: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\SquareConnect\Model\UpsertCatalogObjectRequest	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Return type

\SquareConnect\Model\UpsertCatalogObjectResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CatalogApi.md

Latest commit

History

CatalogApi.md

File metadata and controls

SquareConnect\CatalogApi

batchDeleteCatalogObjects

Example

Parameters

Return type

Authorization

HTTP request headers

batchRetrieveCatalogObjects

Example

Parameters

Return type

Authorization

HTTP request headers

batchUpsertCatalogObjects

Example

Parameters

Return type

Authorization

HTTP request headers

catalogInfo

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCatalogObject

Example

Parameters

Return type

Authorization

HTTP request headers

listCatalog

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveCatalogObject

Example

Parameters

Return type

Authorization

HTTP request headers

searchCatalogObjects

Example

Parameters

Return type

Authorization

HTTP request headers

updateItemModifierLists

Example

Parameters

Return type

Authorization

HTTP request headers

updateItemTaxes

Example

Parameters

Return type

Authorization

HTTP request headers

upsertCatalogObject

Example

Parameters

Return type

Authorization

HTTP request headers