/**
* Get Resource Url for UpdateLocationUsage
* @param string $code User-defined code that uniqely identifies the channel group.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function updateLocationUsageUrl($code, $responseFields)
{
$url = "/api/commerce/settings/locationUsages/{code}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("code", $code);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for GetUser
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $userId Unique identifier of the user whose tenant scopes you want to retrieve.
* @return string Resource Url
*/
public static function getUserUrl($responseFields, $userId)
{
$url = "/api/platform/adminuser/accounts/{userId}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::HOME_POD, "GET", false);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
$url = $mozuUrl->formatUrl("userId", $userId);
return $mozuUrl;
}
/**
* Get Resource Url for UpdateDocumentType
* @param string $documentTypeName The name of the document type to retrieve.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function updateDocumentTypeUrl($documentTypeName, $responseFields)
{
$url = "/api/content/documenttypes/{documentTypeName}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("documentTypeName", $documentTypeName);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for DeleteOption
* @param string $attributeFQN The fully qualified name of the attribute, which is a user defined attribute identifier.
* @param string $productCode Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only.
* @return string Resource Url
*/
public static function deleteOptionUrl($attributeFQN, $productCode)
{
$url = "/api/commerce/catalog/admin/products/{productCode}/Options/{attributeFQN}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("attributeFQN", $attributeFQN);
$url = $mozuUrl->formatUrl("productCode", $productCode);
return $mozuUrl;
}
/**
* Get Resource Url for RefreshUserAuthTicket
* @param string $refreshToken Alphanumeric string used for access tokens. This token refreshes access for accounts by generating a new developer or application account authentication ticket after an access token expires.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function refreshUserAuthTicketUrl($refreshToken, $responseFields)
{
$url = "/api/commerce/customer/authtickets/refresh?refreshToken={refreshToken}&responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("refreshToken", $refreshToken);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for RemoveTransaction
* @param int $accountId Unique identifier of the customer account.
* @param string $transactionId Unique identifier of the transaction to delete.
* @return string Resource Url
*/
public static function removeTransactionUrl($accountId, $transactionId)
{
$url = "/api/commerce/customer/accounts/{accountId}/transactions/{transactionId}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("accountId", $accountId);
$url = $mozuUrl->formatUrl("transactionId", $transactionId);
return $mozuUrl;
}
/**
* Get Resource Url for DeleteOrderNote
* @param string $noteId Unique identifier of a particular note to retrieve.
* @param string $orderId Unique identifier of the order.
* @return string Resource Url
*/
public static function deleteOrderNoteUrl($noteId, $orderId)
{
$url = "/api/commerce/orders/{orderId}/notes/{noteId}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("noteId", $noteId);
$url = $mozuUrl->formatUrl("orderId", $orderId);
return $mozuUrl;
}
/**
* Get Resource Url for DeletePublishSet
* @param bool $discardDrafts
* @param string $publishSetCode
* @return string Resource Url
*/
public static function deletePublishSetUrl($discardDrafts, $publishSetCode)
{
$url = "/api/commerce/catalog/admin/publishing/publishsets/{publishSetCode}?discardDrafts={discardDrafts}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("discardDrafts", $discardDrafts);
$url = $mozuUrl->formatUrl("publishSetCode", $publishSetCode);
return $mozuUrl;
}
/**
* Get Resource Url for AddValidationResult
* @param string $orderId Unique identifier of the order.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function addValidationResultUrl($orderId, $responseFields)
{
$url = "/api/commerce/orders/{orderId}/validationresults?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("orderId", $orderId);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for UpdateVisit
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $visitId Unique identifier of the customer visit to update.
* @return string Resource Url
*/
public static function updateVisitUrl($responseFields, $visitId)
{
$url = "/api/commerce/customer/visits/{visitId}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
$url = $mozuUrl->formatUrl("visitId", $visitId);
return $mozuUrl;
}
/**
* Get Resource Url for GetFacets
* @param string $documentListName Name of content documentListName to delete
* @param string $propertyName The property name associated with the facets to retrieve.
* @return string Resource Url
*/
public static function getFacetsUrl($documentListName, $propertyName)
{
$url = "/api/content/documentlists/{documentListName}/facets/{propertyName}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "GET", false);
$url = $mozuUrl->formatUrl("documentListName", $documentListName);
$url = $mozuUrl->formatUrl("propertyName", $propertyName);
return $mozuUrl;
}
/**
* Get Resource Url for UnAssignDiscount
* @param string $couponSetCode
* @param int $discountId
* @return string Resource Url
*/
public static function unAssignDiscountUrl($couponSetCode, $discountId)
{
$url = "/api/commerce/catalog/admin/couponsets/{couponSetCode}/assigneddiscounts/{discountId}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("couponSetCode", $couponSetCode);
$url = $mozuUrl->formatUrl("discountId", $discountId);
return $mozuUrl;
}
/**
* Get Resource Url for ResendRefundEmail
* @param string $orderId Unique identifier of the order.
* @param string $refundId Unique ID of the refund.
* @return string Resource Url
*/
public static function resendRefundEmailUrl($orderId, $refundId)
{
$url = "/api/commerce/orders/{orderId}/refunds/{refundId}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("orderId", $orderId);
$url = $mozuUrl->formatUrl("refundId", $refundId);
return $mozuUrl;
}
/**
* Get Resource Url for UpdateOrderAttributes
* @param string $orderId Unique identifier of the order.
* @param bool $removeMissing If true, the operation removes missing properties so that the updated order attributes will not show properties with a null value.
* @return string Resource Url
*/
public static function updateOrderAttributesUrl($orderId, $removeMissing)
{
$url = "/api/commerce/orders/{orderId}/attributes?removeMissing={removeMissing}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("orderId", $orderId);
$url = $mozuUrl->formatUrl("removeMissing", $removeMissing);
return $mozuUrl;
}
/**
* Get Resource Url for UpdateMasterCatalog
* @param int $masterCatalogId
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function updateMasterCatalogUrl($masterCatalogId, $responseFields)
{
$url = "/api/commerce/catalog/admin/mastercatalogs/{masterCatalogId}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("masterCatalogId", $masterCatalogId);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for DeleteTreeDocumentContent
* @param string $documentListName Name of content documentListName to delete
* @param string $documentName The name of the document in the site.
* @return string Resource Url
*/
public static function deleteTreeDocumentContentUrl($documentListName, $documentName)
{
$url = "/api/content/documentlists/{documentListName}/documentTree/{documentName}/content?folderPath={folderPath}&folderId={folderId}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("documentListName", $documentListName);
$url = $mozuUrl->formatUrl("documentName", $documentName);
return $mozuUrl;
}
/**
* Get Resource Url for GetAttribute
* @param string $attributeFQN The fully qualified name of the attribute, which is a user defined attribute identifier.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function getAttributeUrl($attributeFQN, $responseFields)
{
$url = "/api/commerce/customer/attributedefinition/attributes/{attributeFQN}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "GET", false);
$url = $mozuUrl->formatUrl("attributeFQN", $attributeFQN);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for GetEvent
* @param string $eventId The unique identifier of the event being retrieved. An event is a notification about a create, read, update, or delete on an order, product, discount or category.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function getEventUrl($eventId, $responseFields)
{
$url = "/api/event/pull/{eventId}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::HOME_POD, "GET", false);
$url = $mozuUrl->formatUrl("eventId", $eventId);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for AddPublishSetItems
* @param string $code User-defined code that uniqely identifies the channel group.
* @param string $responseFields A list or array of fields returned for a call. These fields may be customized and may be used for various types of data calls in Mozu. For example, responseFields are returned for retrieving or updating attributes, carts, and messages in Mozu.
* @return string Resource Url
*/
public static function addPublishSetItemsUrl($code, $responseFields)
{
$url = "/api/content/publishsets/{code}/items?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("code", $code);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for DeleteExtra
* @param string $attributeFQN The fully qualified name of the attribute, which is a user defined attribute identifier.
* @param int $productTypeId Identifier of the product type.
* @return string Resource Url
*/
public static function deleteExtraUrl($attributeFQN, $productTypeId)
{
$url = "/api/commerce/catalog/admin/attributedefinition/producttypes/{productTypeId}/Extras/{attributeFQN}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("attributeFQN", $attributeFQN);
$url = $mozuUrl->formatUrl("productTypeId", $productTypeId);
return $mozuUrl;
}
/**
* Get Resource Url for DeleteShipment
* @param string $orderId Unique identifier of the order.
* @param string $shipmentId Unique identifier of the shipment to retrieve.
* @return string Resource Url
*/
public static function deleteShipmentUrl($orderId, $shipmentId)
{
$url = "/api/commerce/orders/{orderId}/shipments/{shipmentId}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("orderId", $orderId);
$url = $mozuUrl->formatUrl("shipmentId", $shipmentId);
return $mozuUrl;
}
/**
* Get Resource Url for AddTransaction
* @param string $code User-defined code that uniqely identifies the channel group.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function addTransactionUrl($code, $responseFields)
{
$url = "/api/commerce/customer/credits/{code}/transactions?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "POST", false);
$url = $mozuUrl->formatUrl("code", $code);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for UpdateDiscountTarget
* @param int $discountId Unique identifier of the discount. System-supplied and read only.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function updateDiscountTargetUrl($discountId, $responseFields)
{
$url = "/api/commerce/catalog/admin/discounts/{discountId}/target?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("discountId", $discountId);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for GetFile
* @param string $applicationKey
* @param string $fileName
* @return string Resource Url
*/
public static function getFileUrl($applicationKey, $fileName)
{
$url = "/api/platform/appdev/filebasedpackage/packages/{applicationKey}?fileName={fileName}";
$mozuUrl = new MozuUrl($url, UrlLocation::HOME_POD, "GET", false);
$url = $mozuUrl->formatUrl("applicationKey", $applicationKey);
$url = $mozuUrl->formatUrl("fileName", $fileName);
return $mozuUrl;
}
/**
* Get Resource Url for GetTenant
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param int $tenantId Unique identifier of the Mozu tenant.
* @return string Resource Url
*/
public static function getTenantUrl($responseFields, $tenantId)
{
$url = "/api/platform/tenants/{tenantId}?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::HOME_POD, "GET", false);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
$url = $mozuUrl->formatUrl("tenantId", $tenantId);
return $mozuUrl;
}
/**
* Get Resource Url for RemoveCoupon
* @param string $cartId Identifier of the cart to delete.
* @param string $couponCode Code associated with the coupon to remove from the cart.
* @return string Resource Url
*/
public static function removeCouponUrl($cartId, $couponCode)
{
$url = "/api/commerce/carts/{cartId}/coupons/{couponcode}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("cartId", $cartId);
$url = $mozuUrl->formatUrl("couponCode", $couponCode);
return $mozuUrl;
}
/**
* Get Resource Url for ResendPackageFulfillmentEmail
* @param string $orderId Unique identifier of the order.
* @param string $responseFields A list or array of fields returned for a call. These fields may be customized and may be used for various types of data calls in Mozu. For example, responseFields are returned for retrieving or updating attributes, carts, and messages in Mozu.
* @return string Resource Url
*/
public static function resendPackageFulfillmentEmailUrl($orderId, $responseFields)
{
$url = "/api/commerce/orders/{orderId}/fulfillment/email/resend?responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "POST", false);
$url = $mozuUrl->formatUrl("orderId", $orderId);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for RemoveCoupons
* @param string $orderId Unique identifier of the order.
* @param string $updateMode Specifies whether to update the original order, update the order in draft mode, or update the order in draft mode and then commit the changes to the original. Draft mode enables users to make incremental order changes before committing the changes to the original order. Valid values are "ApplyToOriginal," "ApplyToDraft," or "ApplyAndCommit."
* @param string $version System-supplied integer that represents the current version of the order, which prevents users from unintentionally overriding changes to the order. When a user performs an operation for a defined order, the system validates that the version of the updated order matches the version of the order on the server. After the operation completes successfully, the system increments the version number by one.
* @return string Resource Url
*/
public static function removeCouponsUrl($orderId, $updateMode, $version)
{
$url = "/api/commerce/orders/{orderId}/coupons?updatemode={updateMode}&version={version}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "DELETE", false);
$url = $mozuUrl->formatUrl("orderId", $orderId);
$url = $mozuUrl->formatUrl("updateMode", $updateMode);
$url = $mozuUrl->formatUrl("version", $version);
return $mozuUrl;
}
/**
* Get Resource Url for Suggest
* @param string $groups
* @param int $pageSize The number of results to display on each page when creating paged results from a query. The maximum value is 200.
* @param string $query A query entered for searches and facet range.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @return string Resource Url
*/
public static function suggestUrl($groups, $pageSize, $query, $responseFields)
{
$url = "/api/commerce/catalog/storefront/productsearch/suggest?query={query}&groups={groups}&pageSize={pageSize}&responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "GET", false);
$url = $mozuUrl->formatUrl("groups", $groups);
$url = $mozuUrl->formatUrl("pageSize", $pageSize);
$url = $mozuUrl->formatUrl("query", $query);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
return $mozuUrl;
}
/**
* Get Resource Url for SetBillingInfo
* @param string $orderId Unique identifier of the order.
* @param string $responseFields Use this field to include those fields which are not included by default.
* @param string $updateMode Specifies whether to update the original order, update the order in draft mode, or update the order in draft mode and then commit the changes to the original. Draft mode enables users to make incremental order changes before committing the changes to the original order. Valid values are "ApplyToOriginal," "ApplyToDraft," or "ApplyAndCommit."
* @param string $version System-supplied integer that represents the current version of the order, which prevents users from unintentionally overriding changes to the order. When a user performs an operation for a defined order, the system validates that the version of the updated order matches the version of the order on the server. After the operation completes successfully, the system increments the version number by one.
* @return string Resource Url
*/
public static function setBillingInfoUrl($orderId, $responseFields, $updateMode, $version)
{
$url = "/api/commerce/orders/{orderId}/billinginfo?updatemode={updateMode}&version={version}&responseFields={responseFields}";
$mozuUrl = new MozuUrl($url, UrlLocation::TENANT_POD, "PUT", false);
$url = $mozuUrl->formatUrl("orderId", $orderId);
$url = $mozuUrl->formatUrl("responseFields", $responseFields);
$url = $mozuUrl->formatUrl("updateMode", $updateMode);
$url = $mozuUrl->formatUrl("version", $version);
return $mozuUrl;
}
