İçeriğe geç
Admin API

Collection

Serverhttps://magaza-adiniz.myideasoft.com

Collection LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/collection
Bearer
or
OAuth 2.0

Collection LIST › query Parameters

sort
​string

Example sort=id

limit
​integer · min: 1 · max: 100

Number of requested Collections per page

Default: 20
page
​integer · min: 1

Which page to start from

Default: 1
id
​integer · min: 1

Get result by id

ids
​string

Get multiple result by ids

sinceId
​integer · min: 1

Restrict results to after the specified id

displayShowcaseContent
​string · enum

displayShowcaseContent can be 0 or 1

Enum values:
0
1
displayShowcaseFooterContent
​string · enum

displayShowcaseFooterContent can be 0 or 1

Enum values:
0
1
root
​string · enum

Collection root id

Enum values:
8
9
10
startCreatedAt
​string · date · pattern: yyyy-mm-dd

Start of the time frame

endCreatedAt
​string · date · pattern: yyyy-mm-dd

End of the time frame

startUpdatedAt
​string · date · pattern: yyyy-mm-dd

Start of the time frame

endUpdatedAt
​string · date · pattern: yyyy-mm-dd

End of the time frame

q
​string

Collection search filter. Usage: q[]

s
​string

Search key filter.

Collection LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​SeoSettingSummary
createdAt
​string · date-time
updatedAt
​string · date-time

Collection POST

POST
https://magaza-adiniz.myideasoft.com
/admin-api/collection
Bearer
or
OAuth 2.0

Collection POST › Request Body

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​SeoSettingSummary
createdAt
​string · date-time
updatedAt
​string · date-time

Collection POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​SeoSettingSummary
createdAt
​string · date-time
updatedAt
​string · date-time

Collection COUNT

GET
https://magaza-adiniz.myideasoft.com
/admin-api/collection/count
Bearer
or
OAuth 2.0

Collection COUNT › query Parameters

sort
​string

Example sort=id

limit
​integer · min: 1 · max: 100

Number of requested Collections per page

Default: 20
page
​integer · min: 1

Which page to start from

Default: 1
id
​integer · min: 1

Get result by id

ids
​string

Get multiple result by ids

sinceId
​integer · min: 1

Restrict results to after the specified id

displayShowcaseContent
​string · enum

displayShowcaseContent can be 0 or 1

Enum values:
0
1
displayShowcaseFooterContent
​string · enum

displayShowcaseFooterContent can be 0 or 1

Enum values:
0
1
root
​string · enum

Collection root id

Enum values:
8
9
10
startCreatedAt
​string · date · pattern: yyyy-mm-dd

Start of the time frame

endCreatedAt
​string · date · pattern: yyyy-mm-dd

End of the time frame

startUpdatedAt
​string · date · pattern: yyyy-mm-dd

Start of the time frame

endUpdatedAt
​string · date · pattern: yyyy-mm-dd

End of the time frame

q
​string

Collection search filter. Usage: q[]

s
​string

Search key filter.

Collection COUNT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

Kayıt sayısı yanıtı.
total_count
​integer · required

Filtrelere uyan toplam kayıt sayısı.


Collection GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/collection/{id}
Bearer
or
OAuth 2.0

Collection GET › path Parameters

id
​string · pattern: \d+ · required

Collection GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​SeoSettingSummary
createdAt
​string · date-time
updatedAt
​string · date-time

Collection PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/collection/{id}
Bearer
or
OAuth 2.0

Collection PUT › path Parameters

id
​string · pattern: \d+ · required

Collection PUT › Request Body

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​SeoSettingSummary
createdAt
​string · date-time
updatedAt
​string · date-time

Collection PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer · required
name
​string · maxLength: 255 · required
slug
​string · minLength: 1 · maxLength: 255
status
​integer · enum
Enum values:
0
1
sortOrder
​integer · min: 0 · max: 999
showcaseSortOrder
​integer · max: 500
displayShowcaseContent
​integer · enum
Enum values:
0
1
2
showcaseContent
​string
showcaseContentDisplayType
​integer · enum
Enum values:
1
2
3
displayShowcaseFooterContent
​integer · enum
Enum values:
0
1
2
showcaseFooterContent
​string
showcaseFooterContentDisplayType
​integer · enum
Enum values:
1
2
3
pageTitle
​string · maxLength: 255
metaKeywords
​string
metaDescription
​string
canonicalUrl
​string
​SeoSettingSummary
createdAt
​string · date-time
updatedAt
​string · date-time

Collection DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/admin-api/collection/{id}
Bearer
or
OAuth 2.0

Collection DELETE › path Parameters

id
​string · pattern: \d+ · required

Collection DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned