Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference
  2. Products

Media

PreviousProductsNextTypes

catalog Product Attribute Media Gallery Management V1Remove Delete

delete

Remove gallery entry

Path parameters
skustringRequired

(Required)

Example: <string>
entryIdstringRequired

(Required)

Example: <integer>
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
delete
DELETE /V1/products/{sku}/media/{entryId} HTTP/1.1
Host: {{baseurl}}
Accept: */*
true

catalog Product Attribute Media Gallery Management V1Get List Get

get

Retrieve the list of gallery entries associated with given product

Path parameters
skustringRequired

(Required)

Example: <string>
Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/products/{sku}/media HTTP/1.1
Host: {{baseurl}}
Accept: */*
[
  {
    "media_type": "<string>",
    "label": "<string>",
    "position": "<integer>",
    "disabled": "<boolean>",
    "types": [
      "<string>",
      "<string>"
    ],
    "id": "<integer>",
    "file": "<string>",
    "content": {
      "base64_encoded_data": "<string>",
      "type": "<string>",
      "name": "<string>"
    },
    "extension_attributes": {
      "video_content": {
        "media_type": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_provider": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_url": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_title": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_description": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_metadata": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  },
  {
    "media_type": "<string>",
    "label": "<string>",
    "position": "<integer>",
    "disabled": "<boolean>",
    "types": [
      "<string>",
      "<string>"
    ],
    "id": "<integer>",
    "file": "<string>",
    "content": {
      "base64_encoded_data": "<string>",
      "type": "<string>",
      "name": "<string>"
    },
    "extension_attributes": {
      "video_content": {
        "media_type": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_provider": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_url": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_title": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_description": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_metadata": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  }
]
  • GETcatalog Product Attribute Media Gallery Management V1Get Get
  • PUTcatalog Product Attribute Media Gallery Management V1Update Put
  • DELETEcatalog Product Attribute Media Gallery Management V1Remove Delete
  • GETcatalog Product Attribute Media Gallery Management V1Get List Get
  • POSTcatalog Product Attribute Media Gallery Management V1Create Post

catalog Product Attribute Media Gallery Management V1Get Get

get

Return information about gallery entry

Path parameters
skustringRequired

(Required)

Example: <string>
entryIdstringRequired

(Required)

Example: <integer>
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/products/{sku}/media/{entryId} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "media_type": "<string>",
  "label": "<string>",
  "position": "<integer>",
  "disabled": "<boolean>",
  "types": [
    "<string>",
    "<string>"
  ],
  "id": "<integer>",
  "file": "<string>",
  "content": {
    "base64_encoded_data": "<string>",
    "type": "<string>",
    "name": "<string>"
  },
  "extension_attributes": {
    "video_content": {
      "media_type": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_provider": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_url": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_title": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_description": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      },
      "video_metadata": {
        "value": "<Error: Too many levels of nesting to fake this schema>"
      }
    }
  }
}

catalog Product Attribute Media Gallery Management V1Update Put

put

Update gallery entry

Path parameters
skustringRequired

(Required)

Example: <string>
entryIdstringRequired

(Required)

Example: <string>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"entry":{"media_type":"<string>","label":"<string>","position":"<integer>","disabled":"<boolean>","types":["<string>","<string>"],"id":"<integer>","file":"<string>","content":{"base64_encoded_data":"<string>","type":"<string>","name":"<string>"},"extension_attributes":{"video_content":{"media_type":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_provider":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_url":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_title":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_description":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_metadata":{"value":"<Error: Too many levels of nesting to fake this schema>"}}}}}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
put
PUT /V1/products/{sku}/media/{entryId} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 792

{
  "entry": {
    "media_type": "<string>",
    "label": "<string>",
    "position": "<integer>",
    "disabled": "<boolean>",
    "types": [
      "<string>",
      "<string>"
    ],
    "id": "<integer>",
    "file": "<string>",
    "content": {
      "base64_encoded_data": "<string>",
      "type": "<string>",
      "name": "<string>"
    },
    "extension_attributes": {
      "video_content": {
        "media_type": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_provider": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_url": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_title": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_description": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_metadata": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  }
}
true

catalog Product Attribute Media Gallery Management V1Create Post

post

Create new gallery entry

Path parameters
skustringRequired

(Required)

Example: <string>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"entry":{"media_type":"<string>","label":"<string>","position":"<integer>","disabled":"<boolean>","types":["<string>","<string>"],"id":"<integer>","file":"<string>","content":{"base64_encoded_data":"<string>","type":"<string>","name":"<string>"},"extension_attributes":{"video_content":{"media_type":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_provider":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_url":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_title":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_description":{"value":"<Error: Too many levels of nesting to fake this schema>"},"video_metadata":{"value":"<Error: Too many levels of nesting to fake this schema>"}}}}}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/products/{sku}/media HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 792

{
  "entry": {
    "media_type": "<string>",
    "label": "<string>",
    "position": "<integer>",
    "disabled": "<boolean>",
    "types": [
      "<string>",
      "<string>"
    ],
    "id": "<integer>",
    "file": "<string>",
    "content": {
      "base64_encoded_data": "<string>",
      "type": "<string>",
      "name": "<string>"
    },
    "extension_attributes": {
      "video_content": {
        "media_type": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_provider": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_url": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_title": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_description": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        },
        "video_metadata": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    }
  }
}
-34417480