$catalogApi = $client->getCatalogApi();
CatalogApi
- Batch Delete Catalog Objects
- Batch Retrieve Catalog Objects
- Batch Upsert Catalog Objects
- Create Catalog Image
- Update 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
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.
To ensure consistency, only one delete request is processed at a time per seller account.
While one (batch or non-batch) delete request is being processed, other (batched and non-batched)
delete requests are rejected with the 429
error code.
function batchDeleteCatalogObjects(BatchDeleteCatalogObjectsRequest $body): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchDeleteCatalogObjectsRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type BatchDeleteCatalogObjectsResponse
.
$body = BatchDeleteCatalogObjectsRequestBuilder::init()
->objectIds(
[
'W62UWFY35CWMYGVWK6TWJDNI',
'AA27W3M2GGTF3H6AVPNB77CK'
]
)
->build();
$apiResponse = $catalogApi->batchDeleteCatalogObjects($body);
if ($apiResponse->isSuccess()) {
$batchDeleteCatalogObjectsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
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.
function batchRetrieveCatalogObjects(BatchRetrieveCatalogObjectsRequest $body): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchRetrieveCatalogObjectsRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type BatchRetrieveCatalogObjectsResponse
.
$body = BatchRetrieveCatalogObjectsRequestBuilder::init(
[
'W62UWFY35CWMYGVWK6TWJDNI',
'AA27W3M2GGTF3H6AVPNB77CK'
]
)
->includeRelatedObjects(true)
->build();
$apiResponse = $catalogApi->batchRetrieveCatalogObjects($body);
if ($apiResponse->isSuccess()) {
$batchRetrieveCatalogObjectsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
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.
To ensure consistency, only one update request is processed at a time per seller account.
While one (batch or non-batch) update request is being processed, other (batched and non-batched)
update requests are rejected with the 429
error code.
function batchUpsertCatalogObjects(BatchUpsertCatalogObjectsRequest $body): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
body |
BatchUpsertCatalogObjectsRequest |
Body, Required | An object containing the fields to POST for the request. See the corresponding object definition for field details. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type BatchUpsertCatalogObjectsResponse
.
$body = BatchUpsertCatalogObjectsRequestBuilder::init(
'789ff020-f723-43a9-b4b5-43b5dc1fa3dc',
[
CatalogObjectBatchBuilder::init(
[
CatalogObjectBuilder::init(
CatalogObjectType::ITEM,
'#Tea'
)
->presentAtAllLocations(true)
->itemData(
CatalogItemBuilder::init()
->name('Tea')
->taxIds(
[
'#SalesTax'
]
)
->variations(
[
CatalogObjectBuilder::init(
CatalogObjectType::ITEM_VARIATION,
'#Tea_Mug'
)
->presentAtAllLocations(true)
->itemVariationData(
CatalogItemVariationBuilder::init()
->itemId('#Tea')
->name('Mug')
->pricingType(CatalogPricingType::FIXED_PRICING)
->priceMoney(
MoneyBuilder::init()
->amount(150)
->currency(Currency::USD)
->build()
)
->build()
)
->build()
]
)
->categories(
[
CatalogObjectCategoryBuilder::init()
->id('#Beverages')
->build()
]
)
->descriptionHtml('<p><strong>Hot</strong> Leaf Juice</p>')
->build()
)
->build(),
CatalogObjectBuilder::init(
CatalogObjectType::ITEM,
'#Coffee'
)
->presentAtAllLocations(true)
->itemData(
CatalogItemBuilder::init()
->name('Coffee')
->taxIds(
[
'#SalesTax'
]
)
->variations(
[
CatalogObjectBuilder::init(
CatalogObjectType::ITEM_VARIATION,
'#Coffee_Regular'
)
->presentAtAllLocations(true)
->itemVariationData(
CatalogItemVariationBuilder::init()
->itemId('#Coffee')
->name('Regular')
->pricingType(CatalogPricingType::FIXED_PRICING)
->priceMoney(
MoneyBuilder::init()
->amount(250)
->currency(Currency::USD)
->build()
)
->build()
)
->build(),
CatalogObjectBuilder::init(
CatalogObjectType::ITEM_VARIATION,
'#Coffee_Large'
)
->presentAtAllLocations(true)
->itemVariationData(
CatalogItemVariationBuilder::init()
->itemId('#Coffee')
->name('Large')
->pricingType(CatalogPricingType::FIXED_PRICING)
->priceMoney(
MoneyBuilder::init()
->amount(350)
->currency(Currency::USD)
->build()
)
->build()
)
->build()
]
)
->categories(
[
CatalogObjectCategoryBuilder::init()
->id('#Beverages')
->build()
]
)
->descriptionHtml('<p>Hot <em>Bean Juice</em></p>')
->build()
)
->build(),
CatalogObjectBuilder::init(
CatalogObjectType::CATEGORY,
'#Beverages'
)
->presentAtAllLocations(true)
->categoryData(
CatalogCategoryBuilder::init()
->name('Beverages')
->build()
)
->build(),
CatalogObjectBuilder::init(
CatalogObjectType::TAX,
'#SalesTax'
)
->presentAtAllLocations(true)
->taxData(
CatalogTaxBuilder::init()
->name('Sales Tax')
->calculationPhase(TaxCalculationPhase::TAX_SUBTOTAL_PHASE)
->inclusionType(TaxInclusionType::ADDITIVE)
->percentage('5.0')
->appliesToCustomAmounts(true)
->enabled(true)
->build()
)
->build()
]
)->build()
]
)->build();
$apiResponse = $catalogApi->batchUpsertCatalogObjects($body);
if ($apiResponse->isSuccess()) {
$batchUpsertCatalogObjectsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
Uploads an image file to be represented by a CatalogImage object that can be linked to an existing
CatalogObject instance. The resulting CatalogImage
is unattached to any CatalogObject
if the object_id
is not specified.
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.
function createCatalogImage(
?CreateCatalogImageRequest $request = null,
?FileWrapper $imageFile = null
): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
request |
?CreateCatalogImageRequest |
Form (JSON-Encoded), Optional | - |
imageFile |
?FileWrapper |
Form, Optional | - |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type CreateCatalogImageResponse
.
$request = CreateCatalogImageRequestBuilder::init(
'528dea59-7bfb-43c1-bd48-4a6bba7dd61f86',
CatalogObjectBuilder::init(
CatalogObjectType::IMAGE,
'#TEMP_ID'
)
->imageData(
CatalogImageBuilder::init()
->caption('A picture of a cup of coffee')
->build()
)
->build()
)
->objectId('ND6EA5AAJEO5WL3JNNIAQA32')
->build();
$apiResponse = $catalogApi->createCatalogImage($request);
if ($apiResponse->isSuccess()) {
$createCatalogImageResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
Uploads a new image file to replace the existing one in the specified CatalogImage object.
This UpdateCatalogImage
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.
function updateCatalogImage(
string $imageId,
?UpdateCatalogImageRequest $request = null,
?FileWrapper $imageFile = null
): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
imageId |
string |
Template, Required | The ID of the CatalogImage object to update the encapsulated image file. |
request |
?UpdateCatalogImageRequest |
Form (JSON-Encoded), Optional | - |
imageFile |
?FileWrapper |
Form, Optional | - |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type UpdateCatalogImageResponse
.
$imageId = 'image_id4';
$request = UpdateCatalogImageRequestBuilder::init(
'528dea59-7bfb-43c1-bd48-4a6bba7dd61f86'
)->build();
$apiResponse = $catalogApi->updateCatalogImage(
$imageId,
$request
);
if ($apiResponse->isSuccess()) {
$updateCatalogImageResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
Retrieves information about the Square Catalog API, such as batch size
limits that can be used by the BatchUpsertCatalogObjects
endpoint.
function catalogInfo(): ApiResponse
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type CatalogInfoResponse
.
$apiResponse = $catalogApi->catalogInfo();
if ($apiResponse->isSuccess()) {
$catalogInfoResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
Returns a list of all CatalogObjects of the specified types in the catalog.
The types
parameter is specified as a comma-separated list of the CatalogObjectType values,
for example, "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 the include_deleted_objects
attribute value to true
.
function listCatalog(?string $cursor = null, ?string $types = null, ?int $catalogVersion = null): ApiResponse
Parameter | Type | Tags | Description |
---|---|---|---|
cursor |
?string |
Query, Optional | The pagination cursor returned in the previous response. Leave unset for an initial request. The page size is currently set to be 100. See Pagination for more information. |
types |
?string |
Query, Optional | An optional case-insensitive, comma-separated list of object types to retrieve. The valid values are defined in the CatalogObjectType enum, for example, ITEM , ITEM_VARIATION , CATEGORY , DISCOUNT , TAX ,MODIFIER , MODIFIER_LIST , IMAGE , etc.If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults. At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. |
catalogVersion |
?int |
Query, Optional | The specific version of the catalog objects to be included in the response. This allows you to retrieve historical versions of objects. The specified version value is matched against the CatalogObjects' version attribute. If not included, results will be from thecurrent version of the catalog. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type ListCatalogResponse
.
$apiResponse = $catalogApi->listCatalog();
if ($apiResponse->isSuccess()) {
$listCatalogResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
Creates a new or updates the specified CatalogObject.
To ensure consistency, only one update request is processed at a time per seller account.
While one (batch or non-batch) update request is being processed, other (batched and non-batched)
update requests are rejected with the 429
error code.
function upsertCatalogObject(UpsertCatalogObjectRequest $body): ApiResponse
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. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type UpsertCatalogObjectResponse
.
$body = UpsertCatalogObjectRequestBuilder::init(
'af3d1afc-7212-4300-b463-0bfc5314a5ae',
CatalogObjectBuilder::init(
CatalogObjectType::ITEM,
'#Cocoa'
)
->itemData(
CatalogItemBuilder::init()
->name('Cocoa')
->abbreviation('Ch')
->variations(
[
CatalogObjectBuilder::init(
CatalogObjectType::ITEM_VARIATION,
'#Small'
)
->itemVariationData(
CatalogItemVariationBuilder::init()
->itemId('#Cocoa')
->name('Small')
->pricingType(CatalogPricingType::VARIABLE_PRICING)
->build()
)
->build(),
CatalogObjectBuilder::init(
CatalogObjectType::ITEM_VARIATION,
'#Large'
)
->itemVariationData(
CatalogItemVariationBuilder::init()
->itemId('#Cocoa')
->name('Large')
->pricingType(CatalogPricingType::FIXED_PRICING)
->priceMoney(
MoneyBuilder::init()
->amount(400)
->currency(Currency::USD)
->build()
)
->build()
)
->build()
]
)
->descriptionHtml('<p><strong>Hot</strong> Chocolate</p>')
->build()
)
->build()
)->build();
$apiResponse = $catalogApi->upsertCatalogObject($body);
if ($apiResponse->isSuccess()) {
$upsertCatalogObjectResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
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.
To ensure consistency, only one delete request is processed at a time per seller account.
While one (batch or non-batch) delete request is being processed, other (batched and non-batched)
delete requests are rejected with the 429
error code.
function deleteCatalogObject(string $objectId): ApiResponse
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). |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type DeleteCatalogObjectResponse
.
$objectId = 'object_id8';
$apiResponse = $catalogApi->deleteCatalogObject($objectId);
if ($apiResponse->isSuccess()) {
$deleteCatalogObjectResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
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,
?int $catalogVersion = null,
?bool $includeCategoryPathToRoot = false
): ApiResponse
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 therequested objects. Related objects are defined as any objects referenced by ID by the results in the objects fieldof the response. These objects are put in the related_objects field. Setting this to true ishelpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example, if the objects field of the response contains a CatalogItem, its associatedCatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the related_objects field of theresponse. If the objects field of the response contains a CatalogItemVariation,its parent CatalogItem will be returned in the related_objects field ofthe response. Default value: false |
catalogVersion |
?int |
Query, Optional | Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of CatalogObjects. If not included, results will be from the current version of the catalog. |
includeCategoryPathToRoot |
?bool |
Query, Optional | Specifies whether or not to include the path_to_root list for each returned category instance. The path_to_root list consistsof CategoryPathToRootNode objects and specifies the path that starts with the immediate parent category of the returned categoryand ends with its root category. If the returned category is a top-level category, the path_to_root list is empty and is not returnedin the response payload. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type RetrieveCatalogObjectResponse
.
$objectId = 'object_id8';
$includeRelatedObjects = false;
$includeCategoryPathToRoot = false;
$apiResponse = $catalogApi->retrieveCatalogObject(
$objectId,
$includeRelatedObjects,
null,
$includeCategoryPathToRoot
);
if ($apiResponse->isSuccess()) {
$retrieveCatalogObjectResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
Searches for CatalogObject of any type by matching supported search attribute values, excluding custom attribute values on items or item variations, against one or more of the specified query filters.
This (SearchCatalogObjects
) endpoint differs from the SearchCatalogItems
endpoint in the following aspects:
SearchCatalogItems
can only search for items or item variations, whereasSearchCatalogObjects
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, whereSearchCatalogObjects
does not.SearchCatalogItems
does not support theinclude_deleted_objects
filter to search for deleted items or item variations, whereasSearchCatalogObjects
does.- The both endpoints have different call conventions, including the query filter formats.
function searchCatalogObjects(SearchCatalogObjectsRequest $body): ApiResponse
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. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type SearchCatalogObjectsResponse
.
$body = SearchCatalogObjectsRequestBuilder::init()
->objectTypes(
[
CatalogObjectType::ITEM
]
)
->query(
CatalogQueryBuilder::init()
->prefixQuery(
CatalogQueryPrefixBuilder::init(
'name',
'tea'
)->build()
)->build()
)
->limit(100)
->build();
$apiResponse = $catalogApi->searchCatalogObjects($body);
if ($apiResponse->isSuccess()) {
$searchCatalogObjectsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
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 filters.
This (SearchCatalogItems
) endpoint differs from the SearchCatalogObjects
endpoint in the following aspects:
SearchCatalogItems
can only search for items or item variations, whereasSearchCatalogObjects
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, whereSearchCatalogObjects
does not.SearchCatalogItems
does not support theinclude_deleted_objects
filter to search for deleted items or item variations, whereasSearchCatalogObjects
does.- The both endpoints use different call conventions, including the query filter formats.
function searchCatalogItems(SearchCatalogItemsRequest $body): ApiResponse
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. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type SearchCatalogItemsResponse
.
$body = SearchCatalogItemsRequestBuilder::init()
->textFilter('red')
->categoryIds(
[
'WINE_CATEGORY_ID'
]
)
->stockLevels(
[
SearchCatalogItemsRequestStockLevel::OUT,
SearchCatalogItemsRequestStockLevel::LOW
]
)
->enabledLocationIds(
[
'ATL_LOCATION_ID'
]
)
->limit(100)
->sortOrder(SortOrder::ASC)
->productTypes(
[
CatalogItemProductType::REGULAR
]
)
->customAttributeFilters(
[
CustomAttributeFilterBuilder::init()
->customAttributeDefinitionId('VEGAN_DEFINITION_ID')
->boolFilter(true)
->build(),
CustomAttributeFilterBuilder::init()
->customAttributeDefinitionId('BRAND_DEFINITION_ID')
->stringFilter('Dark Horse')
->build(),
CustomAttributeFilterBuilder::init()
->key('VINTAGE')
->numberFilter(
RangeBuilder::init()
->min('2017')
->max('2018')
->build()
)
->build(),
CustomAttributeFilterBuilder::init()
->customAttributeDefinitionId('VARIETAL_DEFINITION_ID')
->build()
]
)
->build();
$apiResponse = $catalogApi->searchCatalogItems($body);
if ($apiResponse->isSuccess()) {
$searchCatalogItemsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
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
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. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type UpdateItemModifierListsResponse
.
$body = UpdateItemModifierListsRequestBuilder::init(
[
'H42BRLUJ5KTZTTMPVSLFAACQ',
'2JXOBJIHCWBQ4NZ3RIXQGJA6'
]
)
->modifierListsToEnable(
[
'H42BRLUJ5KTZTTMPVSLFAACQ',
'2JXOBJIHCWBQ4NZ3RIXQGJA6'
]
)
->modifierListsToDisable(
[
'7WRC16CJZDVLSNDQ35PP6YAD'
]
)
->build();
$apiResponse = $catalogApi->updateItemModifierLists($body);
if ($apiResponse->isSuccess()) {
$updateItemModifierListsResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());
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
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. |
This method returns a Square\Utils\ApiResponse
instance. The getResult()
method on this instance returns the response data which is of type UpdateItemTaxesResponse
.
$body = UpdateItemTaxesRequestBuilder::init(
[
'H42BRLUJ5KTZTTMPVSLFAACQ',
'2JXOBJIHCWBQ4NZ3RIXQGJA6'
]
)
->taxesToEnable(
[
'4WRCNHCJZDVLSNDQ35PP6YAD'
]
)
->taxesToDisable(
[
'AQCEGCEBBQONINDOHRGZISEX'
]
)
->build();
$apiResponse = $catalogApi->updateItemTaxes($body);
if ($apiResponse->isSuccess()) {
$updateItemTaxesResponse = $apiResponse->getResult();
} else {
$errors = $apiResponse->getErrors();
}
// Getting more response information
var_dump($apiResponse->getStatusCode());
var_dump($apiResponse->getHeaders());