Jump to

• Request
• Response

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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Storefront Active Flag

  Maximum Length: 1

  Default Value: true

  Indicates whether a storefront is active or inactive. The default value is true.
• BrandingId: integer (int64)
  Title: Storefront Branding ID

  The branding associated with a storefront.
• DefaultFlag: boolean
  Title: Storefront Default Flag

  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)
  Title: Storefront URL

  The URL associated with a storefront.

{
    "required":[
        "Description",
        "StorefrontCode",
        "StorefrontName"
    ],
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Storefront Active Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a storefront is active or inactive. The default value is true.",
            "nullable":false,
            "default":true
        },
        "BrandingId":{
            "title":"Storefront Branding ID",
            "type":"integer",
            "description":"The branding associated with a storefront.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DefaultFlag":{
            "title":"Storefront Default Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a storefront is the default storefront. The default value is false.",
            "nullable":false
        },
        "Description":{
            "title":"Storefront Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the storefront.",
            "nullable":false
        },
        "StorefrontCode":{
            "title":"Storefront Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the storefront.",
            "nullable":false
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the storefront.",
            "nullable":false
        },
        "StorefrontURL":{
            "title":"Storefront URL",
            "type":"string",
            "description":"The URL associated with a storefront.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront.",
            "items":{
                "$ref":"#/components/schemas/storefronts-images-item-patch-request"
            }
        }
    }
}

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

• Array of: object storefronts-images-item-patch-request

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront.",
    "items":{
        "$ref":"#/components/schemas/storefronts-images-item-patch-request"
    }
}

Nested Schema : storefronts-images-item-patch-request

Type: object

Show Source

• AttachmentName: string
  Title: Attachment Name

  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.

{
    "type":"object",
    "properties":{
        "AttachmentName":{
            "title":"Attachment Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the attachment.",
            "nullable":true
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content of a storefront attachment such as an image file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Storefront Image Context Code",
            "maxLength":30,
            "type":"string",
            "description":"The context or usage of a storefront attachment file.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : storefronts-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Storefront Active Flag

  Maximum Length: 1

  Default Value: true

  Indicates whether a storefront is active or inactive. The default value is true.
• BrandingId: integer (int64)
  Title: Storefront Branding ID

  The branding associated with a storefront.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the storefront.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the storefront was created.
• DefaultFlag: boolean
  Title: Storefront Default Flag

  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)
  Title: Last Updated Date

  Read Only: true

  The date and time when the storefront was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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)
  Title: Storefront URL

  The URL associated with a storefront.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Storefront Active Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a storefront is active or inactive. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "BrandingId":{
            "title":"Storefront Branding ID",
            "type":"integer",
            "description":"The branding associated with a storefront.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the storefront.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the storefront was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultFlag":{
            "title":"Storefront Default Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a storefront is the default storefront. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Storefront Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the storefront.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the storefront was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the storefront.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StorefrontCode":{
            "title":"Storefront Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the storefront.",
            "nullable":false,
            "x-queryable":true
        },
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for a storefront.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the storefront.",
            "nullable":false,
            "x-queryable":true
        },
        "StorefrontURL":{
            "title":"Storefront URL",
            "type":"string",
            "description":"The URL associated with a storefront.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "images":{
            "title":"Images",
            "type":"array",
            "description":"The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront.",
            "items":{
                "$ref":"#/components/schemas/storefronts-images-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

• Array of: object storefronts-images-item-response

{
    "title":"Images",
    "type":"array",
    "description":"The images resource is a child of the storefronts resource and provides a list of image attachments associated with a storefront.",
    "items":{
        "$ref":"#/components/schemas/storefronts-images-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : storefronts-images-item-response

Type: object

Show Source

• AttachmentName: string
  Title: Attachment Name

  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
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the image.
• CreationDate: string (date-time)
  Title: Creation Date

  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)
  Title: Last Updated Date

  Read Only: true

  The date and time when the image was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  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.

{
    "type":"object",
    "properties":{
        "AttachmentName":{
            "title":"Attachment Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentTypeCode":{
            "title":"Attachment Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the attachment.",
            "nullable":false,
            "default":"ORA_STANDARD",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the image.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the image was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ImageContent":{
            "title":"Attachment Content",
            "type":"string",
            "description":"The content of a storefront attachment such as an image file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ImageContextCode":{
            "title":"Storefront Image Context Code",
            "maxLength":30,
            "type":"string",
            "description":"The context or usage of a storefront attachment file.",
            "nullable":true,
            "x-queryable":true
        },
        "ImageId":{
            "title":"Storefront Image ID",
            "type":"integer",
            "description":"The unique identifier for an attachment associated with a storefront.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the image was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the image.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StorefrontAttachmentId":{
            "title":"Storefront Attachment ID",
            "type":"integer",
            "description":"The identifier for an attachment file that's attached to a storefront.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

brandingsLOV

Operation: /fscmRestApi/resources/11.13.18.05/brandings

The list of values for branding.

images

Operation: /fscmRestApi/resources/11.13.18.05/storefronts/{StorefrontId}/child/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.

Back to Top