Update a storefront
patch
/fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}
Request
Path Parameters
-
StorefrontId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether a storefront is active or inactive. The default value is true. -
BrandingId: integer
(int64)
The branding associated with a storefront.
-
DefaultFlag: boolean
Maximum Length:
1
Indicates whether a storefront is the default storefront. The default value is false. -
Description(required): string
Title:
Storefront Description
Maximum Length:240
The description of the storefront. -
images: array
Images
Title:
Images
The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront. -
StorefrontCode(required): string
Title:
Storefront Code
Maximum Length:30
The code of the storefront. -
StorefrontName(required): string
Title:
Storefront Name
Maximum Length:50
The name of the storefront. -
StorefrontURL: string
(byte)
The URL associated with a storefront.
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront.
Show Source
Nested Schema : storefronts-images-item-patch-request
Type:
Show Source
object
-
AttachmentName: string
Maximum Length:
50
The name of the attachment. -
ImageContent: string
(byte)
Title:
Attachment Content
The content of a storefront attachment such as an image file. -
ImageContextCode: string
Title:
Storefront Image Context Code
Maximum Length:30
The context or usage of a storefront attachment file.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : storefronts-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether a storefront is active or inactive. The default value is true. -
BrandingId: integer
(int64)
The branding associated with a storefront.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the storefront. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the storefront was created. -
DefaultFlag: boolean
Maximum Length:
1
Indicates whether a storefront is the default storefront. The default value is false. -
Description: string
Title:
Storefront Description
Maximum Length:240
The description of the storefront. -
images: array
Images
Title:
Images
The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the storefront was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the storefront. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StorefrontCode: string
Title:
Storefront Code
Maximum Length:30
The code of the storefront. -
StorefrontId: integer
(int64)
Title:
Storefront ID
Read Only:true
The unique identifier for a storefront. -
StorefrontName: string
Title:
Storefront Name
Maximum Length:50
The name of the storefront. -
StorefrontURL: string
(byte)
The URL associated with a storefront.
Nested Schema : Images
Type:
array
Title:
Images
The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : storefronts-images-item-response
Type:
Show Source
object
-
AttachmentName: string
Maximum Length:
50
The name of the attachment. -
AttachmentTypeCode: string
Title:
Attachment Type Code
Maximum Length:30
Default Value:ORA_STANDARD
The code of the attachment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the image. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the image was created. -
ImageContent: string
(byte)
Title:
Attachment Content
The content of a storefront attachment such as an image file. -
ImageContextCode: string
Title:
Storefront Image Context Code
Maximum Length:30
The context or usage of a storefront attachment file. -
ImageId: integer
(int64)
Title:
Storefront Image ID
The unique identifier for an attachment associated with a storefront. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the image was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StorefrontAttachmentId: integer
(int64)
Title:
Storefront Attachment ID
The identifier for an attachment file that's attached to a storefront.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- brandingsLOV
-
Operation: /fscmRestApi/resources/11.13.18.05/brandingsThe list of values for branding.
- images
-
Parameters:
- StorefrontId:
$request.path.StorefrontId
The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront. - StorefrontId: