def updateCouponSet(self, couponSet, couponSetCode, responseFields=None):
"""
Args:
| couponSet(couponSet) -
| couponSetCode (string) -
| responseFields (string) -
Returns:
| CouponSet
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/catalog/admin/couponsets/{couponSetCode}?responseFields={responseFields}",
"PUT",
UrlLocation.TenantPod,
False,
)
url.formatUrl("couponSetCode", couponSetCode)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).withBody(couponSet).execute()
return self.client.result()
def getCouponSet(self, couponSetCode, includeCounts=False, responseFields=None):
"""
Args:
| couponSetCode (string) -
| includeCounts (bool) -
| responseFields (string) -
Returns:
| CouponSet
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/catalog/admin/couponsets/{couponSetCode}?includeCounts={includeCounts}&responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("couponSetCode", couponSetCode)
url.formatUrl("includeCounts", includeCounts)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).execute()
return self.client.result()
def updateMasterCatalog(self, masterCatalog, masterCatalogId, responseFields=None):
""" Updates the product publishing mode for the master catalog specified in the request.
Args:
| masterCatalog(masterCatalog) - Properties of a master product catalog defined for a tenant. All catalogs and sites associated with a master catalog share product definitions.
| masterCatalogId (int) -
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| MasterCatalog
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/catalog/admin/mastercatalogs/{masterCatalogId}?responseFields={responseFields}",
"PUT",
UrlLocation.TenantPod,
False,
)
url.formatUrl("masterCatalogId", masterCatalogId)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).withBody(masterCatalog).execute()
return self.client.result()
def addItemToWishlist(self, wishlistItem, wishlistId, responseFields=None):
""" Adds a product in a site's catalog as an item in a shopper wish list.
Args:
| wishlistItem(wishlistItem) - Properties of an item in a shopper wish list.
| wishlistId (string) - Unique identifier of the wish list.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| WishlistItem
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/wishlists/{wishlistId}/items?responseFields={responseFields}",
"POST",
UrlLocation.TenantPod,
False,
)
url.formatUrl("responseFields", responseFields)
url.formatUrl("wishlistId", wishlistId)
self.client.withResourceUrl(url).withBody(wishlistItem).execute()
return self.client.result()
def getCartItem(self, cartItemId, responseFields=None):
""" Retrieves a particular cart item by providing the cart item ID.
Args:
| cartItemId (string) - Identifier of the cart item to delete.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| CartItem
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/carts/current/items/{cartItemId}?responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("cartItemId", cartItemId)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).execute()
return self.client.result()
def getTreeDocumentContent(self, documentListName, documentName):
""" Retrieve the content associated with the document, such as a product image or PDF specifications file.
Args:
| documentListName (string) - Name of content documentListName to delete
| documentName (string) - The name of the document in the site.
Returns:
| Stream
Raises:
| ApiException
"""
url = MozuUrl(
"/api/content/documentlists/{documentListName}/documentTree/{documentName}/content",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("documentListName", documentListName)
url.formatUrl("documentName", documentName)
self.client.withResourceUrl(url).execute()
return self.client.result()
def updateCartItem(self, cartItem, cartItemId, responseFields=None):
""" Update the product or product quantity of an item in the current shopper's cart.
Args:
| cartItem(cartItem) - Properties of an item added to an active shopping cart.
| cartItemId (string) - Identifier of the cart item to delete.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| CartItem
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/carts/current/items/{cartItemId}?responseFields={responseFields}",
"PUT",
UrlLocation.TenantPod,
False,
)
url.formatUrl("cartItemId", cartItemId)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).withBody(cartItem).execute()
return self.client.result()
def getInStockNotificationSubscription(self, id, responseFields=None):
""" Retrieves the details of a subscription that sends a push notification when a product is available in a site's active stock.
Args:
| id (int) - Unique identifier of the customer segment to retrieve.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| InStockNotificationSubscription
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/instocknotifications/{id}?responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("id", id)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).execute()
return self.client.result()
def getOrderReturnableItems(self,orderId, responseFields = None):
""" Retrieves information about which items are eligible for return on an order.Each item displays the following information:
* One entry that represents the entire order item, whether this is a single product, a bundle, or a product or bundle with extras. (ParentProductCode == null, ExcludeProductExtras == false)
* (If the item contains product extras)
* One entry that represents the parent product without product extras (ParentProductCode == null, ExcludeProductExtras == true)
* One entry for each extra (ParentProductCode != null, OrderItemOptionAttributeFQN != null)
* (If the parent item is a bundle)
* One entry for each item within the bundle (ParentProductCode != null, OrderItemOptionAttributeFQN == null)
Args:
| orderId (string) - Unique identifier of the order.
| responseFields (string) - Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
Returns:
| OrderReturnableItemCollection
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/orders/{orderId}/returnableitems?responseFields={responseFields}", "GET", UrlLocation.TenantPod, False);
url.formatUrl("orderId", orderId);
url.formatUrl("responseFields", responseFields);
self.client.withResourceUrl(url).execute();
return self.client.result();
def getMasterCatalog(self, masterCatalogId, responseFields=None):
""" Retrieve the details of the master catalog specified in the request.
Args:
| masterCatalogId (int) - The unique identifier of the master catalog associated with the entity.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| MasterCatalog
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/catalog/admin/mastercatalogs/{masterCatalogId}?responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("masterCatalogId", masterCatalogId)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).execute()
return self.client.result()
def getSearchTuningRule(self, searchTuningRuleCode, responseFields=None):
""" admin-search Get GetSearchTuningRule description DOCUMENT_HERE
Args:
| searchTuningRuleCode (string) -
| responseFields (string) - 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.
Returns:
| SearchTuningRule
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/catalog/admin/search/searchtuningrules/{searchTuningRuleCode}?responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("responseFields", responseFields)
url.formatUrl("searchTuningRuleCode", searchTuningRuleCode)
self.client.withResourceUrl(url).execute()
return self.client.result()
def getUserCartSummary(self, userId, responseFields=None):
""" Retrieves summary information associated with the cart of user specified in the request, including the number of items in the cart, the current total, and whether the cart has expired. All anonymous idle carts that do not proceed to checkout expire after 14 days.
Args:
| userId (string) - Unique identifier of the user whose tenant scopes you want to retrieve.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| CartSummary
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/carts/user/{userId}/summary?responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("responseFields", responseFields)
url.formatUrl("userId", userId)
self.client.withResourceUrl(url).execute()
return self.client.result()
def updateDocumentListType(self, list, documentListTypeFQN, responseFields=None):
""" Updates a DocumentListType
Args:
| list(list) - Properties for the document list type. Document lists contain documents with an associated document type, such as web pages.
| documentListTypeFQN (string) -
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| DocumentListType
Raises:
| ApiException
"""
url = MozuUrl(
"/api/content/documentlistTypes/{documentListTypeFQN}?responseFields={responseFields}",
"PUT",
UrlLocation.TenantPod,
False,
)
url.formatUrl("documentListTypeFQN", documentListTypeFQN)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).withBody(list).execute()
return self.client.result()
def updateWishlistItemQuantity(self, wishlistId, wishlistItemId, quantity, responseFields=None):
""" Updates the quantity of an item in a shopper wish list.
Args:
| wishlistId (string) - Unique identifier of the wish list.
| wishlistItemId (string) - Unique identifier of the item to remove from the shopper wish list.
| quantity (int) - The number of cart items in the shopper's active cart.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| WishlistItem
Raises:
| ApiException
"""
url = MozuUrl(
"/api/commerce/wishlists/{wishlistId}/items/{wishlistItemId}/{quantity}?responseFields={responseFields}",
"PUT",
UrlLocation.TenantPod,
False,
)
url.formatUrl("quantity", quantity)
url.formatUrl("responseFields", responseFields)
url.formatUrl("wishlistId", wishlistId)
url.formatUrl("wishlistItemId", wishlistItemId)
self.client.withResourceUrl(url).execute()
return self.client.result()
def getTreeDocument(self, documentListName, documentName, includeInactive=False, responseFields=None):
""" Retrieves a document based on its document list and folder path in the document hierarchy.
Args:
| documentListName (string) - Name of content documentListName to delete
| documentName (string) - The name of the document in the site.
| includeInactive (bool) -
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| Document
Raises:
| ApiException
"""
url = MozuUrl(
"/api/content/documentlists/{documentListName}/documentTree/{documentName}?includeInactive={includeInactive}&responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("documentListName", documentListName)
url.formatUrl("documentName", documentName)
url.formatUrl("includeInactive", includeInactive)
url.formatUrl("responseFields", responseFields)
self.client.withResourceUrl(url).execute()
return self.client.result()
def updateExtendedProperties(self,extendedProperties, orderId, updateMode = None, version = None, upsert = False):
""" Updates one or more extended properties.
Args:
| extendedProperties(array|extendedProperties) - Mozu.CommerceRuntime.Contracts.Commerce.ExtendedProperty ApiType DOCUMENT_HERE
| orderId (string) - Unique identifier of the order.
| updateMode (string) - 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."
| version (string) - Determines whether or not to check versioning of items for concurrency purposes.
| upsert (bool) - Inserts and updates the extended property.
Returns:
| array of ExtendedProperty
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/orders/{orderId}/extendedproperties?updatemode={updateMode}&version={version}&upsert={upsert}", "PUT", UrlLocation.TenantPod, False);
url.formatUrl("orderId", orderId);
url.formatUrl("updateMode", updateMode);
url.formatUrl("upsert", upsert);
url.formatUrl("version", version);
self.client.withResourceUrl(url).withBody(extendedProperties).execute();
return self.client.result();
def updateProductVariationLocalizedPrice(self,localizedPrice, productCode, variationKey, currencyCode, responseFields = None):
""" Updates the localized price value for a product variation and a specific localized currency.
Args:
| localizedPrice(localizedPrice) - The details of the product variation localized price.
| productCode (string) - The unique, user-defined product code of a product, used throughout to reference and associate to a product.
| variationKey (string) - System-generated key that represents the attribute values that uniquely identify a specific product variation.
| currencyCode (string) - The three character ISO currency code, such as USD for US Dollars.
| responseFields (string) - Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
Returns:
| ProductVariationFixedPrice
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedPrice/{currencyCode}?responseFields={responseFields}", "PUT", UrlLocation.TenantPod, False);
url.formatUrl("currencyCode", currencyCode);
url.formatUrl("productCode", productCode);
url.formatUrl("responseFields", responseFields);
url.formatUrl("variationKey", variationKey);
self.client.withResourceUrl(url).withBody(localizedPrice).execute();
return self.client.result();
def getExtraValueLocalizedDeltaPrice(self,productCode, attributeFQN, value, currencyCode, responseFields = None):
""" Retrieves the localized delta price value for a product extra. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.
Args:
| productCode (string) - The unique, user-defined product code of a product, used throughout to reference and associate to a product.
| attributeFQN (string) - Fully qualified name for an attribute.
| value (string) - The value string to create.
| currencyCode (string) - The three character ISO currency code, such as USD for US Dollars.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| ProductExtraValueDeltaPrice
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/admin/products/{productCode}/Extras/{attributeFQN}/Values/{value}/localizedDeltaPrice/{currencyCode}?responseFields={responseFields}", "GET", UrlLocation.TenantPod, False);
url.formatUrl("attributeFQN", attributeFQN);
url.formatUrl("currencyCode", currencyCode);
url.formatUrl("productCode", productCode);
url.formatUrl("responseFields", responseFields);
url.formatUrl("value", value);
self.client.withResourceUrl(url).execute();
return self.client.result();
def addPropertyValueLocalizedContent(self,localizedContent, productCode, attributeFQN, value, responseFields = None):
""" Adds a property value for localized content. This content is set by the locale code.
Args:
| localizedContent(localizedContent) - Use this field to include those fields which are not included by default.
| productCode (string) - The unique, user-defined product code of a product, used throughout Mozu to reference and associate to a product.
| attributeFQN (string) - Fully qualified name for an attribute.
| value (string) - The value string to create.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| ProductPropertyValueLocalizedContent
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/admin/products/{productCode}/Properties/{attributeFQN}/values/{value}/LocalizedContent?responseFields={responseFields}", "POST", UrlLocation.TenantPod, False);
url.formatUrl("attributeFQN", attributeFQN);
url.formatUrl("productCode", productCode);
url.formatUrl("responseFields", responseFields);
url.formatUrl("value", value);
self.client.withResourceUrl(url).withBody(localizedContent).execute();
return self.client.result();
def upsertPackageFile(self,stream, applicationKey, filepath, lastModifiedTime = None, responseFields = None, contentType = None):
""" platform-developer Post UpsertPackageFile description DOCUMENT_HERE
Args:
| stream(stream) - Data stream that delivers information. Used to input and output data.
| applicationKey (string) -
| filepath (string) -
| lastModifiedTime (string) -
| responseFields (string) - 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.
| contentType (string) - set content type of the data uploaded|
Returns:
| FileMetadata
Raises:
| ApiException
"""
url = MozuUrl("/api/platform/developer/packages/{applicationKey}/files/{filepath}?lastModifiedTime={lastModifiedTime}&responseFields={responseFields}", "POST", UrlLocation.HomePod, False);
url.formatUrl("applicationKey", applicationKey);
url.formatUrl("filepath", filepath);
url.formatUrl("lastModifiedTime", lastModifiedTime);
url.formatUrl("responseFields", responseFields);
self.client.withResourceUrl(url).withBody(stream).withContentType(contentType).execute();
return self.client.result();
def getPublishSetItems(self, code, pageSize=None, startIndex=None, responseFields=None):
""" Retrieve a paged collection of publish set Items.
Args:
| code (string) - User-defined code that uniqely identifies the channel group.
| pageSize (int) - The number of results to display on each page when creating paged results from a query. The amount is divided and displayed on the pageCount amount of pages. The default is 20 and maximum value is 200 per page.
| startIndex (int) - When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with a pageSize of 25, to get the 51st through the 75th items, use startIndex=3 .
| responseFields (string) - 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.
Returns:
| DocumentDraftSummaryPagedCollection
Raises:
| ApiException
"""
url = MozuUrl(
"/api/content/publishsets/{code}/items?pageSize={pageSize}&startIndex={startIndex}&responseFields={responseFields}",
"GET",
UrlLocation.TenantPod,
False,
)
url.formatUrl("code", code)
url.formatUrl("pageSize", pageSize)
url.formatUrl("responseFields", responseFields)
url.formatUrl("startIndex", startIndex)
self.client.withResourceUrl(url).execute()
return self.client.result()
def updateProductVariationLocalizedDeltaPrice(self,localizedDeltaPrice, productCode, variationKey, currencyCode, responseFields = None):
""" Updates the localized delta price value for a product variation. Localized delta prices are deltas between two differing monetary conversion amounts between countries, such as US Dollar vs Euro.
Args:
| localizedDeltaPrice(localizedDeltaPrice) - The difference between the base price for the product and this variation of the product, which can be a positive or negative decimal value. For example, if the base price for a t-shirt product is $10, but the XL variation should cost $12, the DeltaPrice value should be "2". However, if the XS variation should only cost $8, the DeltaPrice value should be "-2".
| productCode (string) - The unique, user-defined product code of a product, used throughout to reference and associate to a product.
| variationKey (string) - System-generated key that represents the attribute values that uniquely identify a specific product variation.
| currencyCode (string) - The three character ISO currency code, such as USD for US Dollars.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| ProductVariationDeltaPrice
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/admin/products/{productCode}/variations/{variationKey}/localizedDeltaPrice/{currencyCode}?responseFields={responseFields}", "PUT", UrlLocation.TenantPod, False);
url.formatUrl("currencyCode", currencyCode);
url.formatUrl("productCode", productCode);
url.formatUrl("responseFields", responseFields);
url.formatUrl("variationKey", variationKey);
self.client.withResourceUrl(url).withBody(localizedDeltaPrice).execute();
return self.client.result();
def changeOrderPriceList(self,priceListCode, orderId, updateMode = None, version = None, responseFields = None):
""" Changes the price list associated with an order. The desired price list code should be specified in the ApiContext.
Args:
| priceListCode(priceListCode) - The unique price list code.
| orderId (string) - Unique identifier of the order.
| updateMode (string) - 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."
| version (string) - Determines whether or not to check versioning of items for concurrency purposes.
| responseFields (string) - Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
Returns:
| Order
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/orders/{orderId}/priceList?updatemode={updateMode}&version={version}&responseFields={responseFields}", "PUT", UrlLocation.TenantPod, False);
url.formatUrl("orderId", orderId);
url.formatUrl("responseFields", responseFields);
url.formatUrl("updateMode", updateMode);
url.formatUrl("version", version);
self.client.withResourceUrl(url).withBody(priceListCode).execute();
return self.client.result();
def suggest(self,query = None, groups = None, pageSize = None, responseFields = None):
""" Suggests possible search terms as the shopper enters search text.
Args:
| query (string) - Properties for the product location inventory provided for queries to locate products by their location.
| groups (string) - Specifies the group that you want this operation to return in the response. This parameter accepts one or more values, separated by comma.For example, if you set this parameter to , then this operation returns a object that contains suggestions for products that match the user entered characters in the search field.The valid values for this parameter are the following:
* — Indicates that products should be matched against and returned in the response. The search value is compared against product name and code. The response contains a with a name of and a collection of . Each collection item has a of Product and contains a equal to a complete product object.
* — Indicates that categories should be matched against and returned in the response. The search value is compared to category name. The response contains a with a name of and a collection of . Each collection item has a of Category and contains a equal to a complete category object.
* — Indicates that previously used search terms (keywords) should be matched against and returned in the response, sorted by frequency of use. Keep in mind that it is not currently possible to edit or remove search terms that may be considered undesirable via the API. The response contains a with a name of and a collection of . Each collection item has a of Term and contains a equal to a string value of the matched search term.
The default value is ; however, the Core Theme only integrates and ignores the group.This operation only returns data that is then made available to your theme. If you set this paramter to multiple values, returns multiple in the response. Depending on your requirements, you can then customize your theme to display the groups together or as separate lists in the displayed search suggestions.
| pageSize (int) - The number of results to display on each page when creating paged results from a query. The maximum value is 200.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| SearchSuggestionResult
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/storefront/productsearch/suggest?query={query}&groups={groups}&pageSize={pageSize}&responseFields={responseFields}", "GET", UrlLocation.TenantPod, False);
url.formatUrl("groups", groups);
url.formatUrl("pageSize", pageSize);
url.formatUrl("query", query);
url.formatUrl("responseFields", responseFields);
self.client.withResourceUrl(url).execute();
return self.client.result();
def configuredProduct(self,productOptionSelections, productCode, includeOptionDetails = False, skipInventoryCheck = False, responseFields = None):
""" Creates a new product configuration each time a shopper selects a product option value. After the shopper defines values for all required product options, the shopper can add the product configuration to a cart.
Args:
| productOptionSelections(productOptionSelections) - For a product with shopper-configurable options, the properties of the product options selected by the shopper.
| productCode (string) - Merchant-created code that uniquely identifies the product such as a SKU or item number. Once created, the product code is read-only.
| includeOptionDetails (bool) - If true, the response returns details about the product. If false, returns a product summary such as the product name, price, and sale price.
| skipInventoryCheck (bool) - If true, skip the process to validate inventory when creating this product reservation.
| responseFields (string) - 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.
Returns:
| ConfiguredProduct
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/storefront/products/{productCode}/configure?includeOptionDetails={includeOptionDetails}&skipInventoryCheck={skipInventoryCheck}&responseFields={responseFields}", "POST", UrlLocation.TenantPod, False);
url.formatUrl("includeOptionDetails", includeOptionDetails);
url.formatUrl("productCode", productCode);
url.formatUrl("responseFields", responseFields);
url.formatUrl("skipInventoryCheck", skipInventoryCheck);
self.client.withResourceUrl(url).withBody(productOptionSelections).execute();
return self.client.result();
def setFulFillmentInfo(self,fulfillmentInfo, orderId, updateMode = None, version = None, responseFields = None):
""" Updates one or more properties of fulfillment information for the specified order.
Args:
| fulfillmentInfo(fulfillmentInfo) - Properties of the information needed to fulfill an order, whether via in-store pickup or direct shipping.
| orderId (string) - Unique identifier of the order.
| updateMode (string) - 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."
| version (string) - 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.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| FulfillmentInfo
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/orders/{orderId}/fulfillmentinfo?updatemode={updateMode}&version={version}&responseFields={responseFields}", "PUT", UrlLocation.TenantPod, False);
url.formatUrl("orderId", orderId);
url.formatUrl("responseFields", responseFields);
url.formatUrl("updateMode", updateMode);
url.formatUrl("version", version);
self.client.withResourceUrl(url).withBody(fulfillmentInfo).execute();
return self.client.result();
def upsertPackageFile(self,stream, applicationKey, filepath, lastModifiedTime = None, responseFields = None, contentType = None):
""" Insert or update the specified file into the specified application package.
Args:
| stream(stream) - Data stream that delivers information. Used to input and output data.
| applicationKey (string) - The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}.
| filepath (string) - The application key uniquely identifies the developer namespace, application ID, version, and package in Dev Center. The format is {Dev Account namespace}.{Application ID}.{Application Version}.{Package name}.
| lastModifiedTime (string) - The date and time of the last file insert or update. This parameter is optional.
| responseFields (string) - Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
| contentType (string) - set content type of the data uploaded|
Returns:
| FileMetadata
Raises:
| ApiException
"""
url = MozuUrl("/api/platform/developer/packages/{applicationKey}/files/{*filepath}?lastModifiedTime={lastModifiedTime}&responseFields={responseFields}", "POST", UrlLocation.HomePod, False);
url.formatUrl("applicationKey", applicationKey);
url.formatUrl("filepath", filepath);
url.formatUrl("lastModifiedTime", lastModifiedTime);
url.formatUrl("responseFields", responseFields);
self.client.withResourceUrl(url).withBody(stream).withContentType(contentType).execute();
return self.client.result();
def updateAttributeVocabularyValueLocalizedContent(self,localizedContent, attributeFQN, value, localeCode, responseFields = None):
""" Updates localized vocabulary value content for an existing attribute, based on the localeCode .
Args:
| localizedContent(localizedContent) - The localized text for the string value of a product attribute.
| attributeFQN (string) - Fully qualified name for an attribute.
| value (string) - The value string to create.
| localeCode (string) - The two character country code that sets the locale, such as US for United States. Sites, tenants, and catalogs use locale codes for localizing content, such as translated product text per supported country.
| responseFields (string) - Use this field to include those fields which are not included by default.
Returns:
| AttributeVocabularyValueLocalizedContent
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/admin/attributedefinition/attributes/{attributeFQN}/VocabularyValues/{value}/LocalizedContent/{localeCode}?responseFields={responseFields}", "PUT", UrlLocation.TenantPod, False);
url.formatUrl("attributeFQN", attributeFQN);
url.formatUrl("localeCode", localeCode);
url.formatUrl("responseFields", responseFields);
url.formatUrl("value", value);
self.client.withResourceUrl(url).withBody(localizedContent).execute();
return self.client.result();
def deleteFacetById(self,facetId):
""" Deletes the facet specified by its unique identifier.
Args:
| facetId (int) - Unique identifier of the facet to retrieve.
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/admin/facets/{facetId}", "DELETE", UrlLocation.TenantPod, False);
url.formatUrl("facetId", facetId);
self.client.withResourceUrl(url).execute();
def deleteDiscount(self,discountId):
""" Deletes a discount specified by its discount ID.
Args:
| discountId (int) - Unique identifier of the discount. System-supplied and read only.
Raises:
| ApiException
"""
url = MozuUrl("/api/commerce/catalog/admin/discounts/{discountId}", "DELETE", UrlLocation.TenantPod, False);
url.formatUrl("discountId", discountId);
self.client.withResourceUrl(url).execute();
