Class AbstractApiRequest

Commercetools\Core\Request\AbstractApiRequest implements Commercetools\Core\Request\ClientRequestInterface, Commercetools\Core\Model\Common\ContextAwareInterface uses Commercetools\Core\Model\Common\ContextTrait

Direct known subclasses

Commercetools\Core\Request\AbstractByIdGetRequest, Commercetools\Core\Request\AbstractByIdHeadRequest, Commercetools\Core\Request\Carts\CartByCustomerIdGetRequest, Commercetools\Core\Request\Customers\CustomerEmailConfirmRequest, Commercetools\Core\Request\Customers\CustomerLoginRequest, Commercetools\Core\Request\Customers\CustomerPasswordChangeRequest, Commercetools\Core\Request\Customers\CustomerPasswordResetRequest, Commercetools\Core\Request\Customers\CustomerPasswordTokenRequest, Commercetools\Core\Request\CustomObjects\AbstractCustomObjectRequest, Commercetools\Core\Request\GraphQL\GraphQLQueryRequest, Commercetools\Core\Request\Me\MeActiveCartRequest, Commercetools\Core\Request\Me\MeEmailConfirmRequest, Commercetools\Core\Request\AbstractByTokenGetRequest, Commercetools\Core\Request\Me\MeGetRequest, Commercetools\Core\Request\Me\MeLoginRequest, Commercetools\Core\Request\Me\MeOrderCreateFromCartRequest, Commercetools\Core\Request\Me\MePasswordChangeRequest, Commercetools\Core\Request\Me\MePasswordResetRequest, Commercetools\Core\Request\OrderEdits\OrderEditApplyRequest, Commercetools\Core\Request\Orders\OrderCreateFromCartRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountMatchingRequest, Commercetools\Core\Request\Products\ProductImageUploadRequest, Commercetools\Core\Request\Products\ProductProjectionBySkuGetRequest, Commercetools\Core\Request\AbstractCreateRequest, Commercetools\Core\Request\Products\ProductProjectionBySlugGetRequest, Commercetools\Core\Request\Project\ProjectGetRequest, Commercetools\Core\Request\PsrRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodByCartIdGetRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodByLocationGetRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodByMatchingLocationGetRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodByMatchingOrderEditGetRequest, Commercetools\Core\Request\AbstractDeleteRequest, Commercetools\Core\Request\AbstractHeadRequest, Commercetools\Core\Request\AbstractProjectionRequest, Commercetools\Core\Request\AbstractQueryRequest, Commercetools\Core\Request\AbstractUpdateRequest, Commercetools\Core\Request\ApiClients\ApiClientDeleteRequest

Indirect known subclasses

Commercetools\Core\Request\AbstractByKeyGetRequest, Commercetools\Core\Request\AbstractByKeyHeadRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountDeleteByKeyRequest, Commercetools\Core\Request\OrderEdits\OrderEditByIdGetRequest, Commercetools\Core\Request\OrderEdits\OrderEditByKeyGetRequest, Commercetools\Core\Request\OrderEdits\OrderEditCreateRequest, Commercetools\Core\Request\OrderEdits\OrderEditDeleteByKeyRequest, Commercetools\Core\Request\OrderEdits\OrderEditDeleteRequest, Commercetools\Core\Request\OrderEdits\OrderEditQueryRequest, Commercetools\Core\Request\OrderEdits\OrderEditUpdateByKeyRequest, Commercetools\Core\Request\OrderEdits\OrderEditUpdateRequest, Commercetools\Core\Request\Orders\OrderByIdGetRequest, Commercetools\Core\Request\Orders\OrderByOrderNumberGetRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountDeleteRequest, Commercetools\Core\Request\Orders\OrderDeleteByOrderNumberRequest, Commercetools\Core\Request\Orders\OrderDeleteRequest, Commercetools\Core\Request\Orders\OrderImportRequest, Commercetools\Core\Request\Orders\OrderQueryRequest, Commercetools\Core\Request\Orders\OrderUpdateByOrderNumberRequest, Commercetools\Core\Request\Orders\OrderUpdateRequest, Commercetools\Core\Request\Payments\PaymentByIdGetRequest, Commercetools\Core\Request\Payments\PaymentByKeyGetRequest, Commercetools\Core\Request\Payments\PaymentCreateRequest, Commercetools\Core\Request\Payments\PaymentDeleteByKeyRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountQueryRequest, Commercetools\Core\Request\Payments\PaymentDeleteRequest, Commercetools\Core\Request\Payments\PaymentQueryRequest, Commercetools\Core\Request\Payments\PaymentUpdateByKeyRequest, Commercetools\Core\Request\Payments\PaymentUpdateRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountByIdGetRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountByKeyGetRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountCreateRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountDeleteByKeyRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountDeleteRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountQueryRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountUpdateByKeyRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountUpdateByKeyRequest, Commercetools\Core\Request\ProductDiscounts\ProductDiscountUpdateRequest, Commercetools\Core\Request\Products\ProductByIdGetRequest, Commercetools\Core\Request\Products\ProductByIdHeadRequest, Commercetools\Core\Request\Products\ProductByIdProductSelectionsGetRequest, Commercetools\Core\Request\Products\ProductByKeyGetRequest, Commercetools\Core\Request\Products\ProductByKeyHeadRequest, Commercetools\Core\Request\Products\ProductByKeyProductSelectionsGetRequest, Commercetools\Core\Request\Products\ProductCreateRequest, Commercetools\Core\Request\Products\ProductDeleteByKeyRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountUpdateRequest, Commercetools\Core\Request\Products\ProductDeleteRequest, Commercetools\Core\Request\Products\ProductHeadRequest, Commercetools\Core\Request\Products\ProductProjectionByIdGetRequest, Commercetools\Core\Request\Products\ProductProjectionByKeyGetRequest, Commercetools\Core\Request\Products\ProductProjectionQueryRequest, Commercetools\Core\Request\Products\ProductProjectionSearchRequest, Commercetools\Core\Request\Products\ProductQueryRequest, Commercetools\Core\Request\Products\ProductsSuggestRequest, Commercetools\Core\Request\Products\ProductUpdateByKeyRequest, Commercetools\Core\Request\Products\ProductUpdateRequest, Commercetools\Core\Request\Carts\CartByIdGetRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionAssignmentsQueryRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionByIdGetRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionByIdProductsGetRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionByKeyGetRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionByKeyProductsGetRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionCreateRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionDeleteByKeyRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionDeleteRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionQueryRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionUpdateByKeyRequest, Commercetools\Core\Request\Carts\CartByKeyGetRequest, Commercetools\Core\Request\ProductSelections\ProductSelectionUpdateRequest, Commercetools\Core\Request\ProductTypes\ProductTypeByIdGetRequest, Commercetools\Core\Request\ProductTypes\ProductTypeByKeyGetRequest, Commercetools\Core\Request\ProductTypes\ProductTypeCreateRequest, Commercetools\Core\Request\ProductTypes\ProductTypeDeleteByKeyRequest, Commercetools\Core\Request\ProductTypes\ProductTypeDeleteRequest, Commercetools\Core\Request\ProductTypes\ProductTypeQueryRequest, Commercetools\Core\Request\ProductTypes\ProductTypeUpdateByKeyRequest, Commercetools\Core\Request\ProductTypes\ProductTypeUpdateRequest, Commercetools\Core\Request\Project\ProjectUpdateRequest, Commercetools\Core\Request\Carts\CartCreateRequest, Commercetools\Core\Request\Reviews\ReviewByIdGetRequest, Commercetools\Core\Request\Reviews\ReviewByKeyGetRequest, Commercetools\Core\Request\Reviews\ReviewCreateRequest, Commercetools\Core\Request\Reviews\ReviewDeleteByKeyRequest, Commercetools\Core\Request\Reviews\ReviewDeleteRequest, Commercetools\Core\Request\Reviews\ReviewQueryRequest, Commercetools\Core\Request\Reviews\ReviewUpdateByKeyRequest, Commercetools\Core\Request\Reviews\ReviewUpdateRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodByIdGetRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodByKeyGetRequest, Commercetools\Core\Request\Carts\CartDeleteByKeyRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodCreateRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodDeleteByKeyRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodDeleteRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodQueryRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodUpdateByKeyRequest, Commercetools\Core\Request\ShippingMethods\ShippingMethodUpdateRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListByIdGetRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListByKeyGetRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListCreateRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListDeleteByKeyRequest, Commercetools\Core\Request\Carts\CartDeleteRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListDeleteRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListQueryRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListUpdateByKeyRequest, Commercetools\Core\Request\ShoppingLists\ShoppingListUpdateRequest, Commercetools\Core\Request\States\StateByIdGetRequest, Commercetools\Core\Request\States\StateCreateRequest, Commercetools\Core\Request\States\StateDeleteRequest, Commercetools\Core\Request\States\StateQueryRequest, Commercetools\Core\Request\States\StateUpdateRequest, Commercetools\Core\Request\Stores\StoreByIdGetRequest, Commercetools\Core\Request\AbstractDeleteByKeyRequest, Commercetools\Core\Request\Carts\CartQueryRequest, Commercetools\Core\Request\Stores\StoreByKeyGetRequest, Commercetools\Core\Request\Stores\StoreCreateRequest, Commercetools\Core\Request\Stores\StoreDeleteByKeyRequest, Commercetools\Core\Request\Stores\StoreDeleteRequest, Commercetools\Core\Request\Stores\StoreQueryRequest, Commercetools\Core\Request\Stores\StoreUpdateByKeyRequest, Commercetools\Core\Request\Stores\StoreUpdateRequest, Commercetools\Core\Request\Subscriptions\SubscriptionByIdGetRequest, Commercetools\Core\Request\Subscriptions\SubscriptionByKeyGetRequest, Commercetools\Core\Request\Subscriptions\SubscriptionCreateRequest, Commercetools\Core\Request\Carts\CartReplicateRequest, Commercetools\Core\Request\Subscriptions\SubscriptionDeleteByKeyRequest, Commercetools\Core\Request\Subscriptions\SubscriptionDeleteRequest, Commercetools\Core\Request\Subscriptions\SubscriptionQueryRequest, Commercetools\Core\Request\Subscriptions\SubscriptionUpdateByKeyRequest, Commercetools\Core\Request\Subscriptions\SubscriptionUpdateRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryByIdGetRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryByKeyGetRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryCreateRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryDeleteByKeyRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryDeleteRequest, Commercetools\Core\Request\Carts\CartUpdateByKeyRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryQueryRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryUpdateByKeyRequest, Commercetools\Core\Request\TaxCategories\TaxCategoryUpdateRequest, Commercetools\Core\Request\Types\TypeByIdGetRequest, Commercetools\Core\Request\Types\TypeByKeyGetRequest, Commercetools\Core\Request\Types\TypeCreateRequest, Commercetools\Core\Request\Types\TypeDeleteByKeyRequest, Commercetools\Core\Request\Types\TypeDeleteRequest, Commercetools\Core\Request\Types\TypeQueryRequest, Commercetools\Core\Request\Types\TypeUpdateByKeyRequest, Commercetools\Core\Request\Carts\CartUpdateRequest, Commercetools\Core\Request\Types\TypeUpdateRequest, Commercetools\Core\Request\Zones\ZoneByIdGetRequest, Commercetools\Core\Request\Zones\ZoneByKeyGetRequest, Commercetools\Core\Request\Zones\ZoneCreateRequest, Commercetools\Core\Request\Zones\ZoneDeleteByKeyRequest, Commercetools\Core\Request\Zones\ZoneDeleteRequest, Commercetools\Core\Request\Zones\ZoneQueryRequest, Commercetools\Core\Request\Zones\ZoneUpdateByKeyRequest, Commercetools\Core\Request\Zones\ZoneUpdateRequest, Commercetools\Core\Request\Categories\CategoryByIdGetRequest, Commercetools\Core\Request\Categories\CategoryByKeyGetRequest, Commercetools\Core\Request\Categories\CategoryCreateRequest, Commercetools\Core\Request\Categories\CategoryDeleteByKeyRequest, Commercetools\Core\Request\Categories\CategoryDeleteRequest, Commercetools\Core\Request\Categories\CategoryQueryRequest, Commercetools\Core\Request\AbstractUpdateByKeyRequest, Commercetools\Core\Request\Categories\CategoryUpdateByKeyRequest, Commercetools\Core\Request\Categories\CategoryUpdateRequest, Commercetools\Core\Request\Channels\ChannelByIdGetRequest, Commercetools\Core\Request\Channels\ChannelCreateRequest, Commercetools\Core\Request\Channels\ChannelDeleteRequest, Commercetools\Core\Request\Channels\ChannelQueryRequest, Commercetools\Core\Request\Channels\ChannelUpdateRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupByIdGetRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupByKeyGetRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupCreateRequest, Commercetools\Core\Request\ApiClients\ApiClientByIdGetRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupDeleteByKeyRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupDeleteRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupQueryRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupUpdateByKeyRequest, Commercetools\Core\Request\CustomerGroups\CustomerGroupUpdateRequest, Commercetools\Core\Request\Customers\CustomerByEmailTokenGetRequest, Commercetools\Core\Request\Customers\CustomerByIdGetRequest, Commercetools\Core\Request\Customers\CustomerByKeyGetRequest, Commercetools\Core\Request\Customers\CustomerByTokenGetRequest, Commercetools\Core\Request\Customers\CustomerCreateRequest, Commercetools\Core\Request\ApiClients\ApiClientCreateRequest, Commercetools\Core\Request\Customers\CustomerDeleteByKeyRequest, Commercetools\Core\Request\Customers\CustomerDeleteRequest, Commercetools\Core\Request\Customers\CustomerEmailTokenRequest, Commercetools\Core\Request\Customers\CustomerQueryRequest, Commercetools\Core\Request\Customers\CustomerUpdateByKeyRequest, Commercetools\Core\Request\Customers\CustomerUpdateRequest, Commercetools\Core\Request\CustomObjects\CustomObjectByIdGetRequest, Commercetools\Core\Request\CustomObjects\CustomObjectByKeyGetRequest, Commercetools\Core\Request\CustomObjects\CustomObjectCreateRequest, Commercetools\Core\Request\CustomObjects\CustomObjectDeleteByKeyRequest, Commercetools\Core\Request\ApiClients\ApiClientQueryRequest, Commercetools\Core\Request\CustomObjects\CustomObjectDeleteRequest, Commercetools\Core\Request\CustomObjects\CustomObjectQueryRequest, Commercetools\Core\Request\DiscountCodes\DiscountCodeByIdGetRequest, Commercetools\Core\Request\DiscountCodes\DiscountCodeCreateRequest, Commercetools\Core\Request\DiscountCodes\DiscountCodeDeleteRequest, Commercetools\Core\Request\DiscountCodes\DiscountCodeQueryRequest, Commercetools\Core\Request\DiscountCodes\DiscountCodeUpdateRequest, Commercetools\Core\Request\Extensions\ExtensionByIdGetRequest, Commercetools\Core\Request\Extensions\ExtensionByKeyGetRequest, Commercetools\Core\Request\Extensions\ExtensionCreateRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountByIdGetRequest, Commercetools\Core\Request\Extensions\ExtensionDeleteByKeyRequest, Commercetools\Core\Request\Extensions\ExtensionDeleteRequest, Commercetools\Core\Request\Extensions\ExtensionQueryRequest, Commercetools\Core\Request\Extensions\ExtensionUpdateByKeyRequest, Commercetools\Core\Request\Extensions\ExtensionUpdateRequest, Commercetools\Core\Request\Inventory\InventoryByIdGetRequest, Commercetools\Core\Request\Inventory\InventoryCreateRequest, Commercetools\Core\Request\Inventory\InventoryDeleteRequest, Commercetools\Core\Request\Inventory\InventoryQueryRequest, Commercetools\Core\Request\Inventory\InventoryUpdateRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountByKeyGetRequest, Commercetools\Core\Request\Me\MeCartByIdRequest, Commercetools\Core\Request\Me\MeCartCreateRequest, Commercetools\Core\Request\Me\MeCartDeleteRequest, Commercetools\Core\Request\Me\MeCartQueryRequest, Commercetools\Core\Request\Me\MeCartUpdateRequest, Commercetools\Core\Request\Me\MeDeleteRequest, Commercetools\Core\Request\Me\MeOrderByIdRequest, Commercetools\Core\Request\Me\MeOrderQueryRequest, Commercetools\Core\Request\Me\MeShoppingListByIdGetRequest, Commercetools\Core\Request\Me\MeShoppingListByKeyGetRequest, Commercetools\Core\Request\CartDiscounts\CartDiscountCreateRequest, Commercetools\Core\Request\Me\MeShoppingListCreateRequest, Commercetools\Core\Request\Me\MeShoppingListDeleteByKeyRequest, Commercetools\Core\Request\Me\MeShoppingListDeleteRequest, Commercetools\Core\Request\Me\MeShoppingListQueryRequest, Commercetools\Core\Request\Me\MeShoppingListUpdateByKeyRequest, Commercetools\Core\Request\Me\MeShoppingListUpdateRequest, Commercetools\Core\Request\Me\MeSignupRequest, Commercetools\Core\Request\Me\MeUpdateRequest, Commercetools\Core\Request\Messages\MessageByIdGetRequest, Commercetools\Core\Request\Messages\MessageQueryRequest

Abstract
Namespace: Commercetools\Core\Request
Located at Core/Request/AbstractApiRequest.php

Methods summary

`public`	# `__construct( Commercetools\Core\Client\JsonEndpoint $endpoint, Commercetools\Core\Model\Common\Context $context = null )` Parameters `$endpoint` `$context`
`public integer`	# `getParamCount( )` Returns integer
`public string`	# `getIdentifier( )` Returns string Implementation of `Commercetools\Core\Request\ClientRequestInterface::getIdentifier()`
`public Commercetools\Core\Request\AbstractApiRequest`	# `setIdentifier( string $identifier )` Parameters `$identifier` Returns `Commercetools\Core\Request\AbstractApiRequest` $this Implementation of `Commercetools\Core\Request\ClientRequestInterface::setIdentifier()`
`public Commercetools\Core\Request\AbstractApiRequest`	# `setExternalUserId( string\|null $externalUserId )` Parameters `$externalUserId` Returns `Commercetools\Core\Request\AbstractApiRequest` $this
`public Commercetools\Core\Request\AbstractApiRequest`	# `addParam( $key, $value = null, boolean $replace = true )` Parameters `$key` `$value` `$replace` Returns `Commercetools\Core\Request\AbstractApiRequest` $this
`public Commercetools\Core\Request\AbstractApiRequest`	# `addParamObject( Commercetools\Core\Request\Query\ParameterInterface $param )` Parameters `$param` Returns `Commercetools\Core\Request\AbstractApiRequest` $this
`public Commercetools\Core\Model\Common\JsonDeserializeInterface\|null`	# `mapResponse( Commercetools\Core\Response\ApiResponseInterface $response )` Deprecated Use mapFromResponse() instead Parameters `$response` Returns `Commercetools\Core\Model\Common\JsonDeserializeInterface`\|null Implementation of `Commercetools\Core\Request\ClientRequestInterface::mapResponse()`
`public mixed`	# `mapFromResponse( Commercetools\Core\Response\ApiResponseInterface\|Psr\Http\Message\ResponseInterface $response, Commercetools\Core\Model\MapperInterface $mapper = null )` Parameters `$response` `$mapper` Returns mixed Inheritdoc Implementation of `Commercetools\Core\Request\ClientRequestInterface::mapFromResponse()`
`public mixed`	# `map( array $data, Commercetools\Core\Model\Common\Context $context = null, Commercetools\Core\Model\MapperInterface $mapper = null )` Parameters `$data` `$context` `$mapper` Returns mixed Implementation of `Commercetools\Core\Request\ClientRequestInterface::map()`
`public Commercetools\Core\Response\ApiResponseInterface`	# `executeWithClient( Commercetools\Core\Client $client, array $headers = null )` Parameters `$client` `$headers` Returns `Commercetools\Core\Response\ApiResponseInterface` Throws `Commercetools\Core\Error\ApiException`

Methods inherited from Commercetools\Core\Request\ClientRequestInterface

Methods inherited from Commercetools\Core\Model\Common\ContextAwareInterface

getContext(), getContextCallback(), setContext(), setContextIfNull()

Methods used from Commercetools\Core\Model\Common\ContextTrait

getContext(), getContextCallback(), setContext(), setContextIfNull()

Constants summary

`string`	`EXTERNAL_USER_HEADER`	# `'X-External-User-ID'`