Square PHP SDK カタログ README

よたか2020.09.10 15:22:37

カタログ

$catalogApi = $client->getCatalogApi();

Class Name

CatalogApi

Methods

カタログ一括削除：Batch Delete Catalog Objects
カタログデータ取得：Batch Retrieve Catalog Objects
カタログ更新：Batch Upsert Catalog Objects
カタログ画像を作成：Create Catalog Image
カタログ情報：Catalog Info
リストカタログ：List Catalog
カタログデータ更新：Upsert Catalog Object
カタログデータ削除：Delete Catalog Object
カタログデータ取得：Retrieve Catalog Object
カタログデータ検索：Search Catalog Objects
カタログデータ検索：Search Catalog Items
アイテムリスト更新：Update Item Modifier Lists
アイテム税更新：Update Item Taxes

Batch Delete Catalog Objects

指定されたターゲットIDのリストに基づいてカタログアイテムのセットを削除し、正常に削除されたIDのセットを応答で返します。削除とはターゲットオブジェクトのすべての子も削除されるようなカスケードイベントです。たとえば、カタログアイテムを削除すると、CatalogItemVariation の子もすべて削除されます。

ターゲットIDの一部しか削除できない場合でも、BatchDeleteCatalogObjects は成功します。応答には、実際に削除されたIDのみが含まれます。

function: batchDeleteCatalogObjects(BatchDeleteCatalogObjectsRequest $body): ApiResponse

パラメーター

Parameter	Type	Tags	Description
body	BatchDeleteCatalogObjectsRequest	Body, Required	必須リクエストに対してPOSTするフィールドを含むオブジェクト。フィールドの詳細については、対応するオブジェクト定義を参照してください。

戻り値

このメソッドは、Square \ Utils \ ApiResponseインスタンスを返します。このインスタンスのgetResult（）メソッドは、タイプBatchDeleteCatalogObjectsResponseの応答データを返します。

例文


$body = new Models\BatchDeleteCatalogObjectsRequest;

$body->setObjectIds(['W62UWFY35CWMYGVWK6TWJDNI', 'AA27W3M2GGTF3H6AVPNB77CK']);



$apiResponse = $catalogApi->batchDeleteCatalogObjects($body);



if ($apiResponse->isSuccess()) {

    $batchDeleteCatalogObjectsResponse = $apiResponse->getResult();

} else {

    $errors = $apiResponse->getErrors();

}



// Get more response info...

// $statusCode = $apiResponse->getStatusCode();

// $headers = $apiResponse->getHeaders();

Batch Retrieve Catalog Objects

指定されたIDに基づいてオブジェクトのセットを返します。セットで返される各CatalogItemには、そのすべてのCatalogItemVariationオブジェクト、CatalogModifierListオブジェクトへの参照、それに適用されるすべてのCatalogTaxオブジェクトのIDを含む、すべての子情報が含まれます。

function: batchRetrieveCatalogObjects(BatchRetrieveCatalogObjectsRequest $body): ApiResponse

パラメーター

Parameter	Type	Tags	Description
body	batchRetrieveCatalogObjectsRequest	Body, Required	必須リクエストに対してPOSTするフィールドを含むオブジェクト。フィールドの詳細については、対応するオブジェクト定義を参照してください。

戻り値

このメソッドは、Square \ Utils \ ApiResponseインスタンスを返します。このインスタンスのgetResult（）メソッドは、タイプBatchRetrieveCatalogObjectsResponseの応答データを返します。

例文


$body_objectIds = ['W62UWFY35CWMYGVWK6TWJDNI', 'AA27W3M2GGTF3H6AVPNB77CK'];

$body = new Models\BatchRetrieveCatalogObjectsRequest(

    $body_objectIds

);

$body->setIncludeRelatedObjects(true);



$apiResponse = $catalogApi->batchRetrieveCatalogObjects($body);



if ($apiResponse->isSuccess()) {

    $batchRetrieveCatalogObjectsResponse = $apiResponse->getResult();

} else {

    $errors = $apiResponse->getErrors();

}



// Get more response info...

// $statusCode = $apiResponse->getStatusCode();

// $headers = $apiResponse->getHeaders();

Batch Upsert Catalog Objects

指定されたオブジェクトのリストに基づいて、最大10,000個のターゲットオブジェクトを作成または更新します。
ターゲットオブジェクトはバッチにグループ化され、各バッチはオールオアナッシング方式で挿入/更新されます。
バッチ内のオブジェクトが何らかの形で不正である場合、またはデータベースの制約に違反している場合、そのアイテムを含むバッチ全体が無視されます。
ただし、同じリクエスト内の他のバッチは引き続き成功する可能性があります。各バッチには最大1,000個のオブジェクトを含めることができ、リクエストのオブジェクトの総数（アイテム、バリエーション、修飾子リスト、割引、税金）が10,000以下である限り、バッチは順番に処理されます。

function: batchUpsertCatalogObjects(BatchUpsertCatalogObjectsRequest $body): ApiResponse

パラメーター

Parameter	Type	Tags	Description
body	BatchUpsertCatalogObjectsRequest	Body, Required	必須リクエストに対してPOSTするフィールドを含むオブジェクト。フィールドの詳細については、対応するオブジェクト定義を参照してください。

戻り値

このメソッドは、Square \ Utils \ ApiResponseインスタンスを返します。このインスタンスのgetResult（）メソッドは、タイプBatchUpsertCatalogObjectsResponseの応答データを返します。

例文

$body_idempotencyKey = '789ff020-f723-43a9-b4b5-43b5dc1fa3dc';

$body_batches = [];



$body_batches_0_objects = [];



$body_batches_0_objects_0_type = Models\CatalogObjectType::ITEM;

$body_batches_0_objects_0_id = '#Tea';

$body_batches_0_objects[0] = new Models\CatalogObject(

    $body_batches_0_objects_0_type,

    $body_batches_0_objects_0_id

);

$body_batches_0_objects[0]->setUpdatedAt('updated_at6');

$body_batches_0_objects[0]->setVersion(252);

$body_batches_0_objects[0]->setIsDeleted(false);

$body_batches_0_objects_0_customAttributeValues = [];



$body_batches_0_objects_0_customAttributeValues['key0'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_0_customAttributeValues['key0']->setName('name1');

$body_batches_0_objects_0_customAttributeValues['key0']->setStringValue('string_value5');

$body_batches_0_objects_0_customAttributeValues['key0']->setCustomAttributeDefinitionId('custom_attribute_definition_id1');

$body_batches_0_objects_0_customAttributeValues['key0']->setType(Models\CatalogCustomAttributeDefinitionType::SELECTION);

$body_batches_0_objects_0_customAttributeValues['key0']->setNumberValue('number_value1');



$body_batches_0_objects_0_customAttributeValues['key1'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_0_customAttributeValues['key1']->setName('name0');

$body_batches_0_objects_0_customAttributeValues['key1']->setStringValue('string_value4');

$body_batches_0_objects_0_customAttributeValues['key1']->setCustomAttributeDefinitionId('custom_attribute_definition_id2');

$body_batches_0_objects_0_customAttributeValues['key1']->setType(Models\CatalogCustomAttributeDefinitionType::STRING);

$body_batches_0_objects_0_customAttributeValues['key1']->setNumberValue('number_value0');

$body_batches_0_objects[0]->setCustomAttributeValues($body_batches_0_objects_0_customAttributeValues);



$body_batches_0_objects_0_catalogV1Ids = [];



$body_batches_0_objects_0_catalogV1Ids[0] = new Models\CatalogV1Id;

$body_batches_0_objects_0_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id4');

$body_batches_0_objects_0_catalogV1Ids[0]->setLocationId('location_id4');

$body_batches_0_objects[0]->setCatalogV1Ids($body_batches_0_objects_0_catalogV1Ids);



$body_batches_0_objects[0]->setPresentAtAllLocations(true);

$body_batches_0_objects[0]->setItemData(new Models\CatalogItem);

$body_batches_0_objects[0]->getItemData()->setName('Tea');

$body_batches_0_objects[0]->getItemData()->setDescription('Hot Leaf Juice');

$body_batches_0_objects[0]->getItemData()->setAbbreviation('abbreviation0');

$body_batches_0_objects[0]->getItemData()->setLabelColor('label_color0');

$body_batches_0_objects[0]->getItemData()->setAvailableOnline(false);

$body_batches_0_objects[0]->getItemData()->setCategoryId('#Beverages');

$body_batches_0_objects[0]->getItemData()->setTaxIds(['#SalesTax']);

$body_batches_0_objects_0_itemData_variations = [];



$body_batches_0_objects_0_itemData_variations_0_type = Models\CatalogObjectType::ITEM_VARIATION;

$body_batches_0_objects_0_itemData_variations_0_id = '#Tea_Mug';

$body_batches_0_objects_0_itemData_variations[0] = new Models\CatalogObject(

    $body_batches_0_objects_0_itemData_variations_0_type,

    $body_batches_0_objects_0_itemData_variations_0_id

);

$body_batches_0_objects_0_itemData_variations[0]->setUpdatedAt('updated_at5');

$body_batches_0_objects_0_itemData_variations[0]->setVersion(99);

$body_batches_0_objects_0_itemData_variations[0]->setIsDeleted(true);

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues = [];



$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key0'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key0']->setName('name0');

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key0']->setStringValue('string_value4');

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key0']->setCustomAttributeDefinitionId('custom_attribute_definition_id2');

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key0']->setType(Models\CatalogCustomAttributeDefinitionType::STRING);

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key0']->setNumberValue('number_value0');



$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key1'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key1']->setName('name1');

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key1']->setStringValue('string_value5');

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key1']->setCustomAttributeDefinitionId('custom_attribute_definition_id1');

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key1']->setType(Models\CatalogCustomAttributeDefinitionType::SELECTION);

$body_batches_0_objects_0_itemData_variations_0_customAttributeValues['key1']->setNumberValue('number_value1');

$body_batches_0_objects_0_itemData_variations[0]->setCustomAttributeValues($body_batches_0_objects_0_itemData_variations_0_customAttributeValues);



$body_batches_0_objects_0_itemData_variations_0_catalogV1Ids = [];



$body_batches_0_objects_0_itemData_variations_0_catalogV1Ids[0] = new Models\CatalogV1Id;

$body_batches_0_objects_0_itemData_variations_0_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id3');

$body_batches_0_objects_0_itemData_variations_0_catalogV1Ids[0]->setLocationId('location_id3');

$body_batches_0_objects_0_itemData_variations[0]->setCatalogV1Ids($body_batches_0_objects_0_itemData_variations_0_catalogV1Ids);



$body_batches_0_objects_0_itemData_variations[0]->setPresentAtAllLocations(true);

$body_batches_0_objects[0]->getItemData()->setVariations($body_batches_0_objects_0_itemData_variations);





$body_batches_0_objects_1_type = Models\CatalogObjectType::ITEM;

$body_batches_0_objects_1_id = '#Coffee';

$body_batches_0_objects[1] = new Models\CatalogObject(

    $body_batches_0_objects_1_type,

    $body_batches_0_objects_1_id

);

$body_batches_0_objects[1]->setUpdatedAt('updated_at7');

$body_batches_0_objects[1]->setVersion(253);

$body_batches_0_objects[1]->setIsDeleted(true);

$body_batches_0_objects_1_customAttributeValues = [];



$body_batches_0_objects_1_customAttributeValues['key0'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_1_customAttributeValues['key0']->setName('name2');

$body_batches_0_objects_1_customAttributeValues['key0']->setStringValue('string_value6');

$body_batches_0_objects_1_customAttributeValues['key0']->setCustomAttributeDefinitionId('custom_attribute_definition_id0');

$body_batches_0_objects_1_customAttributeValues['key0']->setType(Models\CatalogCustomAttributeDefinitionType::NUMBER);

$body_batches_0_objects_1_customAttributeValues['key0']->setNumberValue('number_value2');

$body_batches_0_objects[1]->setCustomAttributeValues($body_batches_0_objects_1_customAttributeValues);



$body_batches_0_objects_1_catalogV1Ids = [];



$body_batches_0_objects_1_catalogV1Ids[0] = new Models\CatalogV1Id;

$body_batches_0_objects_1_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id5');

$body_batches_0_objects_1_catalogV1Ids[0]->setLocationId('location_id5');



$body_batches_0_objects_1_catalogV1Ids[1] = new Models\CatalogV1Id;

$body_batches_0_objects_1_catalogV1Ids[1]->setCatalogV1Id('catalog_v1_id6');

$body_batches_0_objects_1_catalogV1Ids[1]->setLocationId('location_id6');

$body_batches_0_objects[1]->setCatalogV1Ids($body_batches_0_objects_1_catalogV1Ids);



$body_batches_0_objects[1]->setPresentAtAllLocations(true);

$body_batches_0_objects[1]->setItemData(new Models\CatalogItem);

$body_batches_0_objects[1]->getItemData()->setName('Coffee');

$body_batches_0_objects[1]->getItemData()->setDescription('Hot Bean Juice');

$body_batches_0_objects[1]->getItemData()->setAbbreviation('abbreviation9');

$body_batches_0_objects[1]->getItemData()->setLabelColor('label_color9');

$body_batches_0_objects[1]->getItemData()->setAvailableOnline(true);

$body_batches_0_objects[1]->getItemData()->setCategoryId('#Beverages');

$body_batches_0_objects[1]->getItemData()->setTaxIds(['#SalesTax']);

$body_batches_0_objects_1_itemData_variations = [];



$body_batches_0_objects_1_itemData_variations_0_type = Models\CatalogObjectType::ITEM_VARIATION;

$body_batches_0_objects_1_itemData_variations_0_id = '#Coffee_Regular';

$body_batches_0_objects_1_itemData_variations[0] = new Models\CatalogObject(

    $body_batches_0_objects_1_itemData_variations_0_type,

    $body_batches_0_objects_1_itemData_variations_0_id

);

$body_batches_0_objects_1_itemData_variations[0]->setUpdatedAt('updated_at4');

$body_batches_0_objects_1_itemData_variations[0]->setVersion(100);

$body_batches_0_objects_1_itemData_variations[0]->setIsDeleted(false);

$body_batches_0_objects_1_itemData_variations_0_customAttributeValues = [];



$body_batches_0_objects_1_itemData_variations_0_customAttributeValues['key0'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_1_itemData_variations_0_customAttributeValues['key0']->setName('name9');

$body_batches_0_objects_1_itemData_variations_0_customAttributeValues['key0']->setStringValue('string_value3');

$body_batches_0_objects_1_itemData_variations_0_customAttributeValues['key0']->setCustomAttributeDefinitionId('custom_attribute_definition_id3');

$body_batches_0_objects_1_itemData_variations_0_customAttributeValues['key0']->setType(Models\CatalogCustomAttributeDefinitionType::BOOLEAN);

$body_batches_0_objects_1_itemData_variations_0_customAttributeValues['key0']->setNumberValue('number_value9');

$body_batches_0_objects_1_itemData_variations[0]->setCustomAttributeValues($body_batches_0_objects_1_itemData_variations_0_customAttributeValues);



$body_batches_0_objects_1_itemData_variations_0_catalogV1Ids = [];



$body_batches_0_objects_1_itemData_variations_0_catalogV1Ids[0] = new Models\CatalogV1Id;

$body_batches_0_objects_1_itemData_variations_0_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id4');

$body_batches_0_objects_1_itemData_variations_0_catalogV1Ids[0]->setLocationId('location_id4');



$body_batches_0_objects_1_itemData_variations_0_catalogV1Ids[1] = new Models\CatalogV1Id;

$body_batches_0_objects_1_itemData_variations_0_catalogV1Ids[1]->setCatalogV1Id('catalog_v1_id5');

$body_batches_0_objects_1_itemData_variations_0_catalogV1Ids[1]->setLocationId('location_id5');

$body_batches_0_objects_1_itemData_variations[0]->setCatalogV1Ids($body_batches_0_objects_1_itemData_variations_0_catalogV1Ids);



$body_batches_0_objects_1_itemData_variations[0]->setPresentAtAllLocations(true);



$body_batches_0_objects_1_itemData_variations_1_type = Models\CatalogObjectType::ITEM_VARIATION;

$body_batches_0_objects_1_itemData_variations_1_id = '#Coffee_Large';

$body_batches_0_objects_1_itemData_variations[1] = new Models\CatalogObject(

    $body_batches_0_objects_1_itemData_variations_1_type,

    $body_batches_0_objects_1_itemData_variations_1_id

);

$body_batches_0_objects_1_itemData_variations[1]->setUpdatedAt('updated_at3');

$body_batches_0_objects_1_itemData_variations[1]->setVersion(101);

$body_batches_0_objects_1_itemData_variations[1]->setIsDeleted(true);

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues = [];



$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key0'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key0']->setName('name8');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key0']->setStringValue('string_value2');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key0']->setCustomAttributeDefinitionId('custom_attribute_definition_id4');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key0']->setType(Models\CatalogCustomAttributeDefinitionType::NUMBER);

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key0']->setNumberValue('number_value8');



$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key1'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key1']->setName('name9');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key1']->setStringValue('string_value3');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key1']->setCustomAttributeDefinitionId('custom_attribute_definition_id3');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key1']->setType(Models\CatalogCustomAttributeDefinitionType::BOOLEAN);

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key1']->setNumberValue('number_value9');



$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key2'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key2']->setName('name0');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key2']->setStringValue('string_value4');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key2']->setCustomAttributeDefinitionId('custom_attribute_definition_id2');

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key2']->setType(Models\CatalogCustomAttributeDefinitionType::STRING);

$body_batches_0_objects_1_itemData_variations_1_customAttributeValues['key2']->setNumberValue('number_value0');

$body_batches_0_objects_1_itemData_variations[1]->setCustomAttributeValues($body_batches_0_objects_1_itemData_variations_1_customAttributeValues);



$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids = [];



$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[0] = new Models\CatalogV1Id;

$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id5');

$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[0]->setLocationId('location_id5');



$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[1] = new Models\CatalogV1Id;

$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[1]->setCatalogV1Id('catalog_v1_id6');

$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[1]->setLocationId('location_id6');



$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[2] = new Models\CatalogV1Id;

$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[2]->setCatalogV1Id('catalog_v1_id7');

$body_batches_0_objects_1_itemData_variations_1_catalogV1Ids[2]->setLocationId('location_id7');

$body_batches_0_objects_1_itemData_variations[1]->setCatalogV1Ids($body_batches_0_objects_1_itemData_variations_1_catalogV1Ids);



$body_batches_0_objects_1_itemData_variations[1]->setPresentAtAllLocations(true);

$body_batches_0_objects[1]->getItemData()->setVariations($body_batches_0_objects_1_itemData_variations);





$body_batches_0_objects_2_type = Models\CatalogObjectType::CATEGORY;

$body_batches_0_objects_2_id = '#Beverages';

$body_batches_0_objects[2] = new Models\CatalogObject(

    $body_batches_0_objects_2_type,

    $body_batches_0_objects_2_id

);

$body_batches_0_objects[2]->setUpdatedAt('updated_at8');

$body_batches_0_objects[2]->setVersion(254);

$body_batches_0_objects[2]->setIsDeleted(false);

$body_batches_0_objects_2_customAttributeValues = [];



$body_batches_0_objects_2_customAttributeValues['key0'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_2_customAttributeValues['key0']->setName('name3');

$body_batches_0_objects_2_customAttributeValues['key0']->setStringValue('string_value7');

$body_batches_0_objects_2_customAttributeValues['key0']->setCustomAttributeDefinitionId('custom_attribute_definition_id9');

$body_batches_0_objects_2_customAttributeValues['key0']->setType(Models\CatalogCustomAttributeDefinitionType::BOOLEAN);

$body_batches_0_objects_2_customAttributeValues['key0']->setNumberValue('number_value3');



$body_batches_0_objects_2_customAttributeValues['key1'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_2_customAttributeValues['key1']->setName('name2');

$body_batches_0_objects_2_customAttributeValues['key1']->setStringValue('string_value6');

$body_batches_0_objects_2_customAttributeValues['key1']->setCustomAttributeDefinitionId('custom_attribute_definition_id0');

$body_batches_0_objects_2_customAttributeValues['key1']->setType(Models\CatalogCustomAttributeDefinitionType::NUMBER);

$body_batches_0_objects_2_customAttributeValues['key1']->setNumberValue('number_value2');



$body_batches_0_objects_2_customAttributeValues['key2'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_2_customAttributeValues['key2']->setName('name1');

$body_batches_0_objects_2_customAttributeValues['key2']->setStringValue('string_value5');

$body_batches_0_objects_2_customAttributeValues['key2']->setCustomAttributeDefinitionId('custom_attribute_definition_id1');

$body_batches_0_objects_2_customAttributeValues['key2']->setType(Models\CatalogCustomAttributeDefinitionType::SELECTION);

$body_batches_0_objects_2_customAttributeValues['key2']->setNumberValue('number_value1');

$body_batches_0_objects[2]->setCustomAttributeValues($body_batches_0_objects_2_customAttributeValues);



$body_batches_0_objects_2_catalogV1Ids = [];



$body_batches_0_objects_2_catalogV1Ids[0] = new Models\CatalogV1Id;

$body_batches_0_objects_2_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id6');

$body_batches_0_objects_2_catalogV1Ids[0]->setLocationId('location_id6');



$body_batches_0_objects_2_catalogV1Ids[1] = new Models\CatalogV1Id;

$body_batches_0_objects_2_catalogV1Ids[1]->setCatalogV1Id('catalog_v1_id7');

$body_batches_0_objects_2_catalogV1Ids[1]->setLocationId('location_id7');



$body_batches_0_objects_2_catalogV1Ids[2] = new Models\CatalogV1Id;

$body_batches_0_objects_2_catalogV1Ids[2]->setCatalogV1Id('catalog_v1_id8');

$body_batches_0_objects_2_catalogV1Ids[2]->setLocationId('location_id8');

$body_batches_0_objects[2]->setCatalogV1Ids($body_batches_0_objects_2_catalogV1Ids);



$body_batches_0_objects[2]->setPresentAtAllLocations(true);



$body_batches_0_objects_3_type = Models\CatalogObjectType::TAX;

$body_batches_0_objects_3_id = '#SalesTax';

$body_batches_0_objects[3] = new Models\CatalogObject(

    $body_batches_0_objects_3_type,

    $body_batches_0_objects_3_id

);

$body_batches_0_objects[3]->setUpdatedAt('updated_at9');

$body_batches_0_objects[3]->setVersion(255);

$body_batches_0_objects[3]->setIsDeleted(true);

$body_batches_0_objects_3_customAttributeValues = [];



$body_batches_0_objects_3_customAttributeValues['key0'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_3_customAttributeValues['key0']->setName('name4');

$body_batches_0_objects_3_customAttributeValues['key0']->setStringValue('string_value8');

$body_batches_0_objects_3_customAttributeValues['key0']->setCustomAttributeDefinitionId('custom_attribute_definition_id8');

$body_batches_0_objects_3_customAttributeValues['key0']->setType(Models\CatalogCustomAttributeDefinitionType::STRING);

$body_batches_0_objects_3_customAttributeValues['key0']->setNumberValue('number_value4');



$body_batches_0_objects_3_customAttributeValues['key1'] = new Models\CatalogCustomAttributeValue;

$body_batches_0_objects_3_customAttributeValues['key1']->setName('name3');

$body_batches_0_objects_3_customAttributeValues['key1']->setStringValue('string_value7');

$body_batches_0_objects_3_customAttributeValues['key1']->setCustomAttributeDefinitionId('custom_attribute_definition_id9');

$body_batches_0_objects_3_customAttributeValues['key1']->setType(Models\CatalogCustomAttributeDefinitionType::BOOLEAN);

$body_batches_0_objects_3_customAttributeValues['key1']->setNumberValue('number_value3');

$body_batches_0_objects[3]->setCustomAttributeValues($body_batches_0_objects_3_customAttributeValues);



$body_batches_0_objects_3_catalogV1Ids = [];



$body_batches_0_objects_3_catalogV1Ids[0] = new Models\CatalogV1Id;

$body_batches_0_objects_3_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id7');

$body_batches_0_objects_3_catalogV1Ids[0]->setLocationId('location_id7');

$body_batches_0_objects[3]->setCatalogV1Ids($body_batches_0_objects_3_catalogV1Ids);



$body_batches_0_objects[3]->setPresentAtAllLocations(true);



$body_batches[0] = new Models\CatalogObjectBatch(

    $body_batches_0_objects

);



$body = new Models\BatchUpsertCatalogObjectsRequest(

    $body_idempotencyKey,

    $body_batches

);



$apiResponse = $catalogApi->batchUpsertCatalogObjects($body);



if ($apiResponse->isSuccess()) {

    $batchUpsertCatalogObjectsResponse = $apiResponse->getResult();

} else {

    $errors = $apiResponse->getErrors();

}



// Get more response info...

// $statusCode = $apiResponse->getStatusCode();

// $headers = $apiResponse->getHeaders();

Create Catalog Image

Uploads an image file to be represented by an CatalogImage object linked to an existing CatalogObject instance. A call to this endpoint can upload an image, link an image to a catalog object, or do both.

This CreateCatalogImage endpoint accepts HTTP multipart/form-data requests with a JSON part and an image file part in JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.

Additional information and an example cURL request can be found in the Create a Catalog Image recipe.

function createCatalogImage(
?CreateCatalogImageRequest $request = null,
?\Square\Utils\FileWrapper $imageFile = null
): ApiResponse
Parameters

Parameter Type Tags Description
request ?CreateCatalogImageRequest Form, Optional -
imageFile ?\Square\Utils\FileWrapper Form, Optional -
Response Type

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

Example Usage

$request_idempotencyKey = '528dea59-7bfb-43c1-bd48-4a6bba7dd61f86';
$request = new Models\CreateCatalogImageRequest(
$request_idempotencyKey
);
$request->setObjectId('ND6EA5AAJEO5WL3JNNIAQA32');
$request_image_type = Models\CatalogObjectType::IMAGE;
$request_image_id = '#TEMP_ID';
$request->setImage(new Models\CatalogObject(
$request_image_type,
$request_image_id
));
$request->getImage()->setUpdatedAt('updated_at4');
$request->getImage()->setVersion(68);
$request->getImage()->setIsDeleted(false);
$request_image_customAttributeValues = [];

$request_image_customAttributeValues[''] = new Models\CatalogCustomAttributeValue;

$request_image_customAttributeValues[''] = new Models\CatalogCustomAttributeValue;
$request->getImage()->setCustomAttributeValues($request_image_customAttributeValues);

$request_image_catalogV1Ids = [];

$request_image_catalogV1Ids[0] = new Models\CatalogV1Id;
$request_image_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id4');
$request_image_catalogV1Ids[0]->setLocationId('location_id4');
$request->getImage()->setCatalogV1Ids($request_image_catalogV1Ids);

$imageFile = 'dummy_file';

$apiResponse = $catalogApi->createCatalogImage($request, $imageFile);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Catalog Info

Retrieves information about the Square Catalog API, such as batch size limits that can be used by the BatchUpsertCatalogObjects endpoint.

function catalogInfo(): ApiResponse
Response Type

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

Example Usage

$apiResponse = $catalogApi->catalogInfo();

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
List Catalog

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.

function listCatalog(?string $cursor = null, ?string $types = null): ApiResponse
Parameters

Parameter Type Tags Description
cursor ?string Query, Optional The pagination cursor returned in the previous response. Leave unset for an initial request.
See Pagination for more information.
types ?string Query, Optional 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.
Response Type

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

Example Usage

$cursor = 'cursor6';
$types = 'types6';

$apiResponse = $catalogApi->listCatalog($cursor, $types);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Upsert Catalog Object

Creates or updates the target CatalogObject.

function upsertCatalogObject(UpsertCatalogObjectRequest $body): ApiResponse
Parameters

Parameter Type Tags Description
body UpsertCatalogObjectRequest 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 UpsertCatalogObjectResponse.

Example Usage

$body_idempotencyKey = 'af3d1afc-7212-4300-b463-0bfc5314a5ae';
$body_object_type = Models\CatalogObjectType::ITEM;
$body_object_id = '#Cocoa';
$body_object = new Models\CatalogObject(
$body_object_type,
$body_object_id
);
$body_object->setUpdatedAt('updated_at8');
$body_object->setVersion(252);
$body_object->setIsDeleted(false);
$body_object_customAttributeValues = [];

$body_object_customAttributeValues[''] = new Models\CatalogCustomAttributeValue;

$body_object_customAttributeValues[''] = new Models\CatalogCustomAttributeValue;

$body_object_customAttributeValues[''] = new Models\CatalogCustomAttributeValue;
$body_object->setCustomAttributeValues($body_object_customAttributeValues);

$body_object_catalogV1Ids = [];

$body_object_catalogV1Ids[0] = new Models\CatalogV1Id;
$body_object_catalogV1Ids[0]->setCatalogV1Id('catalog_v1_id0');
$body_object_catalogV1Ids[0]->setLocationId('location_id0');

$body_object_catalogV1Ids[1] = new Models\CatalogV1Id;
$body_object_catalogV1Ids[1]->setCatalogV1Id('catalog_v1_id1');
$body_object_catalogV1Ids[1]->setLocationId('location_id1');

$body_object_catalogV1Ids[2] = new Models\CatalogV1Id;
$body_object_catalogV1Ids[2]->setCatalogV1Id('catalog_v1_id2');
$body_object_catalogV1Ids[2]->setLocationId('location_id2');
$body_object->setCatalogV1Ids($body_object_catalogV1Ids);

$body_object->setItemData(new Models\CatalogItem);
$body_object->getItemData()->setName('Cocoa');
$body_object->getItemData()->setDescription('Hot chocolate');
$body_object->getItemData()->setAbbreviation('Ch');
$body_object->getItemData()->setLabelColor('label_color4');
$body_object->getItemData()->setAvailableOnline(false);
$body = new Models\UpsertCatalogObjectRequest(
$body_idempotencyKey,
$body_object
);

$apiResponse = $catalogApi->upsertCatalogObject($body);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Delete Catalog Object

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.

function deleteCatalogObject(string $objectId): ApiResponse
Parameters

Parameter Type Tags Description
objectId string Template, Required 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).
Response Type

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

Example Usage

$objectId = 'object_id8';

$apiResponse = $catalogApi->deleteCatalogObject($objectId);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Retrieve Catalog Object

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.

function retrieveCatalogObject(string $objectId, ?bool $includeRelatedObjects = false): ApiResponse
Parameters

Parameter Type Tags Description
objectId string Template, Required The object ID of any type of catalog objects to be retrieved.
includeRelatedObjects ?bool Query, Optional 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
Response Type

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

Example Usage

$objectId = 'object_id8';
$includeRelatedObjects = false;

$apiResponse = $catalogApi->retrieveCatalogObject($objectId, $includeRelatedObjects);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Search Catalog Objects

Searches for CatalogObject of any types against supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query expressions,

This (SearchCatalogObjects) endpoint differs from the SearchCatalogItems endpoint in the following aspects:

SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
SearchCatalogItems supports the custom attribute query filters to return items or item variations that contain custom attribute values, where SearchCatalogObjects does not.
SearchCatalogItems does not support the include_deleted_objects filter to search for deleted items or item variations, whereas SearchCatalogObjects does.
The both endpoints have different call conventions, including the query filter formats.
function searchCatalogObjects(SearchCatalogObjectsRequest $body): ApiResponse
Parameters

Parameter Type Tags Description
body SearchCatalogObjectsRequest 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 SearchCatalogObjectsResponse.

Example Usage

$body = new Models\SearchCatalogObjectsRequest;
$body->setCursor('cursor0');
$body->setObjectTypes([Models\CatalogObjectType::ITEM]);
$body->setIncludeDeletedObjects(false);
$body->setIncludeRelatedObjects(false);
$body->setBeginTime('begin_time4');
$body->setQuery(new Models\CatalogQuery);
$body_query_sortedAttributeQuery_attributeName = 'attribute_name6';
$body->getQuery()->setSortedAttributeQuery(new Models\CatalogQuerySortedAttribute(
$body_query_sortedAttributeQuery_attributeName
));
$body->getQuery()->getSortedAttributeQuery()->setInitialAttributeValue('initial_attribute_value4');
$body->getQuery()->getSortedAttributeQuery()->setSortOrder(Models\SortOrder::DESC);
$body_query_exactQuery_attributeName = 'attribute_name2';
$body_query_exactQuery_attributeValue = 'attribute_value2';
$body->getQuery()->setExactQuery(new Models\CatalogQueryExact(
$body_query_exactQuery_attributeName,
$body_query_exactQuery_attributeValue
));
$body_query_prefixQuery_attributeName = 'name';
$body_query_prefixQuery_attributePrefix = 'tea';
$body->getQuery()->setPrefixQuery(new Models\CatalogQueryPrefix(
$body_query_prefixQuery_attributeName,
$body_query_prefixQuery_attributePrefix
));
$body_query_rangeQuery_attributeName = 'attribute_name6';
$body->getQuery()->setRangeQuery(new Models\CatalogQueryRange(
$body_query_rangeQuery_attributeName
));
$body->getQuery()->getRangeQuery()->setAttributeMinValue(14);
$body->getQuery()->getRangeQuery()->setAttributeMaxValue(180);
$body_query_textQuery_keywords = ['keywords7'];
$body->getQuery()->setTextQuery(new Models\CatalogQueryText(
$body_query_textQuery_keywords
));
$body->setLimit(100);

$apiResponse = $catalogApi->searchCatalogObjects($body);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Search Catalog Items

Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query expressions,

This (SearchCatalogItems) endpoint differs from the SearchCatalogObjects endpoint in the following aspects:

SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
SearchCatalogItems supports the custom attribute query filters to return items or item variations that contain custom attribute values, where SearchCatalogObjects does not.
SearchCatalogItems does not support the include_deleted_objects filter to search for deleted items or item variations, whereas SearchCatalogObjects does.
The both endpoints use different call conventions, including the query filter formats.
function searchCatalogItems(SearchCatalogItemsRequest $body): ApiResponse
Parameters

Parameter Type Tags Description
body SearchCatalogItemsRequest 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 SearchCatalogItemsResponse.

Example Usage

$body = new Models\SearchCatalogItemsRequest;
$body->setTextFilter('red');
$body->setCategoryIds(['WINE_CATEGORY_ID']);
$body->setStockLevels([Models\SearchCatalogItemsRequestStockLevel::OUT, Models\SearchCatalogItemsRequestStockLevel::LOW]);
$body->setEnabledLocationIds(['ATL_LOCATION_ID']);
$body->setCursor('cursor0');
$body->setLimit(100);
$body->setSortOrder(Models\SortOrder::ASC);
$body->setProductTypes([Models\CatalogItemProductType::REGULAR]);
$body_customAttributeFilters = [];

$body_customAttributeFilters[0] = new Models\CustomAttributeFilter;
$body_customAttributeFilters[0]->setCustomAttributeDefinitionId('VEGAN_DEFINITION_ID');
$body_customAttributeFilters[0]->setKey('key2');
$body_customAttributeFilters[0]->setStringFilter('string_filter4');
$body_customAttributeFilters[0]->setNumberFilter(new Models\Range);
$body_customAttributeFilters[0]->getNumberFilter()->setMin('min0');
$body_customAttributeFilters[0]->getNumberFilter()->setMax('max2');
$body_customAttributeFilters[0]->setSelectionUidsFilter(['selection_uids_filter2', 'selection_uids_filter3']);
$body_customAttributeFilters[0]->setBoolFilter(true);

$body_customAttributeFilters[1] = new Models\CustomAttributeFilter;
$body_customAttributeFilters[1]->setCustomAttributeDefinitionId('BRAND_DEFINITION_ID');
$body_customAttributeFilters[1]->setKey('key3');
$body_customAttributeFilters[1]->setStringFilter('Dark Horse');
$body_customAttributeFilters[1]->setNumberFilter(new Models\Range);
$body_customAttributeFilters[1]->getNumberFilter()->setMin('min1');
$body_customAttributeFilters[1]->getNumberFilter()->setMax('max1');
$body_customAttributeFilters[1]->setSelectionUidsFilter(['selection_uids_filter1']);

$body_customAttributeFilters[2] = new Models\CustomAttributeFilter;
$body_customAttributeFilters[2]->setCustomAttributeDefinitionId('custom_attribute_definition_id8');
$body_customAttributeFilters[2]->setKey('VINTAGE');
$body_customAttributeFilters[2]->setStringFilter('string_filter6');
$body_customAttributeFilters[2]->setNumberFilter(new Models\Range);
$body_customAttributeFilters[2]->getNumberFilter()->setMin('2017');
$body_customAttributeFilters[2]->getNumberFilter()->setMax('2018');
$body_customAttributeFilters[2]->setSelectionUidsFilter(['selection_uids_filter0', 'selection_uids_filter1', 'selection_uids_filter2']);

$body_customAttributeFilters[3] = new Models\CustomAttributeFilter;
$body_customAttributeFilters[3]->setCustomAttributeDefinitionId('VARIETAL_DEFINITION_ID');
$body_customAttributeFilters[3]->setKey('key5');
$body_customAttributeFilters[3]->setStringFilter('string_filter7');
$body_customAttributeFilters[3]->setNumberFilter(new Models\Range);
$body_customAttributeFilters[3]->getNumberFilter()->setMin('min3');
$body_customAttributeFilters[3]->getNumberFilter()->setMax('max9');
$body_customAttributeFilters[3]->setSelectionUidsFilter(['selection_uids_filter9', 'selection_uids_filter0']);
$body->setCustomAttributeFilters($body_customAttributeFilters);

$apiResponse = $catalogApi->searchCatalogItems($body);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Update Item Modifier Lists

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

function updateItemModifierLists(UpdateItemModifierListsRequest $body): ApiResponse
Parameters

Parameter Type Tags Description
body UpdateItemModifierListsRequest 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 UpdateItemModifierListsResponse.

Example Usage

$body_itemIds = ['H42BRLUJ5KTZTTMPVSLFAACQ', '2JXOBJIHCWBQ4NZ3RIXQGJA6'];
$body = new Models\UpdateItemModifierListsRequest(
$body_itemIds
);
$body->setModifierListsToEnable(['H42BRLUJ5KTZTTMPVSLFAACQ', '2JXOBJIHCWBQ4NZ3RIXQGJA6']);
$body->setModifierListsToDisable(['7WRC16CJZDVLSNDQ35PP6YAD']);

$apiResponse = $catalogApi->updateItemModifierLists($body);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();
Update Item Taxes

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

function updateItemTaxes(UpdateItemTaxesRequest $body): ApiResponse
Parameters

Parameter Type Tags Description
body UpdateItemTaxesRequest 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 UpdateItemTaxesResponse.

Example Usage

$body_itemIds = ['H42BRLUJ5KTZTTMPVSLFAACQ', '2JXOBJIHCWBQ4NZ3RIXQGJA6'];
$body = new Models\UpdateItemTaxesRequest(
$body_itemIds
);
$body->setTaxesToEnable(['4WRCNHCJZDVLSNDQ35PP6YAD']);
$body->setTaxesToDisable(['AQCEGCEBBQONINDOHRGZISEX']);

$apiResponse = $catalogApi->updateItemTaxes($body);

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

// Get more response info...
// $statusCode = $apiResponse->getStatusCode();
// $headers = $apiResponse->getHeaders();

カタログ

Class Name

Methods

Batch Delete Catalog Objects

パラメーター

戻り値

例文

Batch Retrieve Catalog Objects

パラメーター

戻り値

例文

Batch Upsert Catalog Objects

パラメーター

戻り値

例文

Square PHP SDK カタログ README

Square PHP SDK README