Product File
/
Update product file type

Management API (v1)

The Norce Management API lets you manage configurations and metadata on a client.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/

Schemas

Settings ApplicationCountry

Operations

Settings ApplicationCulture

Operations

Settings ApplicationCurrency

Operations

Settings ApplicationSalesArea

Operations

Settings Application

Operations

Category

Operations

CategoryParametric

Operations

Settings ClientAssortment

Operations

Settings ClientCurrency

Operations

Settings ClientSalesArea

Operations

Customer FlagGroup

Operations

Customer Flag

Operations

Customer InfoType

Operations

Product Family

Operations

Product File

Operations

Get product file type

Request

Get a specific product file type by its internal Id

Path
idinteger(int32)required

Product file type id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/file/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the File

Bodyapplication/json
Idinteger(int32)

The unique identifier of the file type

Namestring or null[ 0 .. 50 ] characters

The localized name of the file type for a specific culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the file type for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The localized description of the file type for a specific culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description of the file type for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

Codestring or null

The code identifier of the file

TypeIdinteger(int32)required

The type identifier of the file, e.g., jpg, gif, pdf, mp4, etc.

TypeExtensionstring or null

The file extension, from the built-in file type for this file type, e.g., "jpg", "gif", "pdf", "mp4" etc.

TypeMimeTypestring or null

The MIME type, from the built-in file type for this file type, e.g., "image/jpeg", "application/pdf", etc.

SortOrderinteger or null(int32)

The sort order of the file type, used for displaying file types in choices and lists in the admin interface. And is also provided in API results.

IsActivebooleanrequired

Indicates whether the file type is active

IsImageboolean

Indicates whether the file type is an image

Changedstring or null

The date and time the file type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the file type

CulturesArray of objects(FileCultureModel)

The collection of culture-specific data for the file type

Response
application/json
{
  "Id": 0,
  "Name": "string",
  "DefaultName": "string",
  "IsNameInherited": true,
  "Description": "string",
  "DefaultDescription": "string",
  "IsDescriptionInherited": true,
  "Code": "string",
  "TypeId": 0,
  "TypeExtension": "string",
  "TypeMimeType": "string",
  "SortOrder": 0,
  "IsActive": true,
  "IsImage": true,
  "Changed": "string",
  "ChangedBy": "string",
  "Cultures": [
    { … }
  ]
}

Update product file type

Request

Update an existing product file type

Path
idinteger(int32)required

Product file type id

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

A product file type to update

Idinteger(int32)

The unique identifier of the file type

Namestring or null[ 0 .. 50 ] characters

The localized name of the file type for a specific culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the file type for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The localized description of the file type for a specific culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description of the file type for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

Codestring or null

The code identifier of the file

TypeIdinteger(int32)required

The type identifier of the file, e.g., jpg, gif, pdf, mp4, etc.

TypeExtensionstring or null

The file extension, from the built-in file type for this file type, e.g., "jpg", "gif", "pdf", "mp4" etc.

TypeMimeTypestring or null

The MIME type, from the built-in file type for this file type, e.g., "image/jpeg", "application/pdf", etc.

SortOrderinteger or null(int32)

The sort order of the file type, used for displaying file types in choices and lists in the admin interface. And is also provided in API results.

IsActivebooleanrequired

Indicates whether the file type is active

IsImageboolean

Indicates whether the file type is an image

Changedstring or null

The date and time the file type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the file type

CulturesArray of objects(FileCultureModel)

The collection of culture-specific data for the file type

curl -i -X PUT \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/file/{id}' \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "TypeId": 0,
    "TypeExtension": "string",
    "TypeMimeType": "string",
    "SortOrder": 0,
    "IsActive": true,
    "IsImage": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the product file type was successfully updated

Bodyapplication/json
integer(int32)
Response
application/json
0

Delete a product file type

Request

Delete an existing product file type from the client

Path
idinteger(int32)required

Product file type id to delete

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X DELETE \
  'https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/file/{id}' \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

If the product file type was successfully deleted

Bodyapplication/json
integer(int32)
Response
application/json
0

List active product file types

Request

Get a list of all active product file types on the client, optionally filter by image or non-image types

Query
isImageboolean or null

Optional filter to only include image file types (true) or non-image file types (false)

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

curl -i -X GET \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/file \
  -H 'account-id: 0' \
  -H 'application-id: 0'

Responses

Returns the list of product file types, if any exists

Bodyapplication/jsonArray [
Idinteger(int32)

The unique identifier of the file type

Namestring or null[ 0 .. 50 ] characters

The localized name of the file type for a specific culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the file type for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The localized description of the file type for a specific culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description of the file type for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

Codestring or null

The code identifier of the file

TypeIdinteger(int32)required

The type identifier of the file, e.g., jpg, gif, pdf, mp4, etc.

TypeExtensionstring or null

The file extension, from the built-in file type for this file type, e.g., "jpg", "gif", "pdf", "mp4" etc.

TypeMimeTypestring or null

The MIME type, from the built-in file type for this file type, e.g., "image/jpeg", "application/pdf", etc.

SortOrderinteger or null(int32)

The sort order of the file type, used for displaying file types in choices and lists in the admin interface. And is also provided in API results.

IsActivebooleanrequired

Indicates whether the file type is active

IsImageboolean

Indicates whether the file type is an image

Changedstring or null

The date and time the file type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the file type

CulturesArray of objects(FileCultureModel)

The collection of culture-specific data for the file type

]
Response
application/json
[
  {
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "TypeId": 0,
    "TypeExtension": "string",
    "TypeMimeType": "string",
    "SortOrder": 0,
    "IsActive": true,
    "IsImage": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [ … ]
  }
]

Add a product file type

Request

Add a new product file type to the client

Headers
account-idintegerrequired

User Account ID

application-idintegerrequired

Application ID

Bodyapplication/jsonrequired

A product file type to add

Idinteger(int32)

The unique identifier of the file type

Namestring or null[ 0 .. 50 ] characters

The localized name of the file type for a specific culture

DefaultNamestring or null[ 0 .. 50 ] characters

The name of the file type for the default language

IsNameInheritedboolean

Indicates whether the name is inherited from the default

Descriptionstring or null[ 0 .. 500 ] characters

The localized description of the file type for a specific culture

DefaultDescriptionstring or null[ 0 .. 500 ] characters

The description of the file type for the default language

IsDescriptionInheritedboolean

Indicates whether the description is inherited from the default

Codestring or null

The code identifier of the file

TypeIdinteger(int32)required

The type identifier of the file, e.g., jpg, gif, pdf, mp4, etc.

TypeExtensionstring or null

The file extension, from the built-in file type for this file type, e.g., "jpg", "gif", "pdf", "mp4" etc.

TypeMimeTypestring or null

The MIME type, from the built-in file type for this file type, e.g., "image/jpeg", "application/pdf", etc.

SortOrderinteger or null(int32)

The sort order of the file type, used for displaying file types in choices and lists in the admin interface. And is also provided in API results.

IsActivebooleanrequired

Indicates whether the file type is active

IsImageboolean

Indicates whether the file type is an image

Changedstring or null

The date and time the file type was last changed

ChangedBystring or null

Fullname or Systemname of the user who last changed the file type

CulturesArray of objects(FileCultureModel)

The collection of culture-specific data for the file type

curl -i -X POST \
  https://customer-slug.api-se.playground.norce.tech/commerce/management/1.0/api/product/file \
  -H 'Content-Type: application/json' \
  -H 'account-id: 0' \
  -H 'application-id: 0' \
  -d '{
    "Id": 0,
    "Name": "string",
    "DefaultName": "string",
    "IsNameInherited": true,
    "Description": "string",
    "DefaultDescription": "string",
    "IsDescriptionInherited": true,
    "Code": "string",
    "TypeId": 0,
    "TypeExtension": "string",
    "TypeMimeType": "string",
    "SortOrder": 0,
    "IsActive": true,
    "IsImage": true,
    "Changed": "string",
    "ChangedBy": "string",
    "Cultures": [
      {
        "CultureCode": "string",
        "IsTranslated": true,
        "Name": "string",
        "IsNameInherited": true,
        "Description": "string",
        "IsDescriptionInherited": true
      }
    ]
  }'

Responses

If the product file type was successfully added

Bodyapplication/json
integer(int32)
Response
application/json
0

Product Manufacturer

Operations

Parametric Group

Operations

Parametric List

Operations

Parametric Multiple

Operations

Parametric

Operations

PriceList Population

Operations

PriceList Pricing

Operations

PriceList

Operations

PriceList SupplierPriceList

Operations

PriceList Warehouse

Operations

Product FlagGroup

Operations

Product Flag

Operations

Product InfoType

Operations

Product Type

Operations

Promotion

Operations

Product RelationType

Operations

PriceList RoundingRule

Operations

Shopping InfoType

Operations

Store Application

Operations

Store PriceList

Operations

Store

Operations

Store Warehouse

Operations

Supplier PriceList

Operations

Supplier PriceListWarehouse

Operations

Supplier

Operations

Supplier Warehouse

Operations

Supplier WarehouseLocation

Operations

Product VariantGroup

Operations

Product WarehouseLocation

Operations

Product Warehouse

Operations