1 of 24

API Documentation

What is Mediablob

Mediablob API is the developer interface for storing product information in the Shoppa eco-system.

The api comes in several versions. All api versions are both forward and backwards compatible with any version of the Shoppa Client, but to take full advantage of the latest functionality of Shoppa Client, your Mediablob integration must use the latest api version.

All xml schema definitions (xsd) can be downloaded at XSD

The customer node

An integral part of the Shoppa eco-system is the customer tree. All users belong to a customer node, which in turn has a parent node. All customer nodes for a tree in this way, with one parent and optionally multiple children.

The customer tree is created by Shoppas specialists together with the customer. Contact Shoppa Support Centre if you need to update the customer tree.

Any product or storeinfo-object created at a node is available to all lower levels, provided it is not restriced by country code.

A customer can also get access to content from an external customer node if a reference is created to that node. This is used for instance to provide supplier information to several different companies. Customer references can only be created and removed by Shoppas solution architects.

The Product object

All information in Mediablob is based around a product. Products support different languages and can be restricted to a specific country.

A product has several named text fields. Allowed field names are defined in the and are used by Tags in Shoppa templates to display the correct product information.

At a customer level, the product stores up to one text and one image per field and language code.

The same picture can be assigned to several fields and different pictures can be assigned to the same field, but for different language codes. This is especially useful for images with embedded texts.

Products can be partially overridden at any customer level. This information is then used for all customer node further down the tree. If an overriden text is later deleted, the original text is restored.

The Product primarily stores static information that is not bound by time. When a product is updated the change is visible immediately to all users and remains the same until the product is changed again. Thus, products shall not contain volatile information such as price. Such properties should be handled by StoreInfo objects.

The StoreInfo object

Existing products can be enriched for specific customers and timespans.

While any text or picture of a product can be overridden, StoreInfo objects typically describe pricelists or campaigns. StoreInfo is perfect for tracking different product prices per store.

It is important to create the products before relating to them in StoreInfo objects.

Fields

Products have a number of fields in which you can enter information about the product. This document provides a short summary of the fields common to all users. New, specialized, fields can be created on a customer basis, contact your Shoppa representative for more information.

Required fields

When creating a new product, there are certain fields that must be defined:

Brand
Product name
At least one Code field (see below)

Code fields

Code fields are special, in that their values must be unique. That is, no two of your products may contain the same value in, for example, their Code 1 field. The uniqueness constraint does not carry over multiple fields, e.g. one products Code 1 can be the same as another products Code 3 without issue. The constraint also doesn't carry over between customers, i.e. one of your products may have the same Code 1 as a product belonging to another customer.

Identifier

Data Type

Recommendation

Text fields

Identifier

Data type

Text recommendation

Price fields

Price fields are only available in price lists and campaigns. They can therefore only be integrated using the storeinformation XML.

Identifier

Data type

Use case

Picture fields

Pictures can be attached to any fields, but we do have some recommendations, i.e. the main product picture should go in the 'product name' field. These recommendations are listed below.

Primary image - productname
Secondary image - techname
Third image - infoshort

Additional fields

There are additional fields with no intended use case. These can be used if there are no other suiting fields available.

Identifier

Data type

Endpoints

The Mediablob API 1.0 is based on xml.

While the original transport was only over SOAP, Mediablob now supports async posting of xml files over https. This method is much easier to use, and returns control faster to your application.

While there are no immediate plans to remove the legacy soap support, the async https transport is highly recommended for new api development.

HTTPS endpoints

There are two available endpoints; one for development and testing, and the other for production use.

Development: https://api.test2.mediablob.com/api/xml
Production: https://api.mediablob.com/api/xml

REST/HTTP Developer tools

Since the api supports standard http requests, it is easy to connect any environment to the api once you have your account details.

An effective way of testing the Mediablob integration is by using Chrome with the extension .

Install the addon.
Open the new app from the upper right corner of Chrome.
Select the Method, i.e. PUT and fill in the url to the endpoint

Shoppa also provides C# source code for a sample application that uploads xml files to the api.

Legacy SOAP endpoints

There are two available endpoints; one for development and testing, and the other for production use.

Development: http://ws.test2.mediablob.com/services/products.asmx
Production: http://ws.mediablob.com/services/products.asmx

You can open the endpoint urls in a standard browser and read about the provided functions.

SOAP Developer tools

Since the api supports standard soap requests, it is easy to connect any environment to the api once you have your account details.

An effective way of testing the Mediablob integration is by using Chrome with the extension .

Install the addon.
Browse to the wsdl-definition of the webserver at .
Click on the Wizdler icon in the addons toolbar and select the function you want to call.

Shoppa also provides C# source code for a sample application that uploads xml files to the api.

How to use the endpoints properly

Use the development endpoint for development and integration testing. The test environments have additional data format validation that gives better developer feedback. By working in a testing sandbox, you ensure any errors can be detected without affecting production users.

Switch to the production endpoint when uploaded data shall be seen by the end users.

The environments can of course be used in parallel. Just understand that testing and production environments are completely separated.

Requesting user access

You will need a username and password to access any services in the Mediablob api. You also need to know your customer id(s) for many operations.

Accounts to the test and production environments are provided by the Shoppa Support Centre. Ask your Shoppa representative to request an account on your behalf.

Authorization

An authorization is necessary for the request towards Shoppa's REST API or SOAP protocol. The documentation provides a description on how to receive credentials for an integration user

Integration users and customer nodes are managed set up and managed by Shoppa. Contact your Shoppa representative if you need help with the management.

Integration user

An integration user consists of four parameters that are necessary for the integration purpose. The parameters are "username", "password", "languageCode", and "countryCode".

Username and password are used to authenticate your requests. They are part of the authentication header.

LanguageCode and countryCode values determine which languages and countries you can store Mediablob data on. These values are used in the Shoppa XML's to decide where to store the data and who should be able to access it.

Customer nodes

Customer nodes always consists of a ShoppaID which is an auto incremental value. Each customer node has the option for a custom ExternalID value. Either value can be used when uploading Shoppa XML's to decide where the data should be stored.

REST

All endpoints use a leaky bucket queue algorithm. There is a max capacity of 50 messages at a time with a renewal of 1 message per 5 seconds.

/api/xml

Used for uploading Shoppa XML's to the integration service bus queue

PUT https://api.mediablob.com/api/xml

Available Shoppa XML's can be found at

Headers

Name

Type

Description

Request Body

Name

Type

Description

SessionId example:

Used for uploading a custom XML to the integration service

PUT https://api.mediablob.com/api/xml/custom

Custom XML's will be passed through one or several XSLT schemas before being uploaded to the service bus queue. XSLTs are uploaded by Shoppa. To upload or change an XSLT, contact your Shoppa representative for help.

Headers

Name

Type

Description

Request Body

Name

Type

Description

SessionId example:

Operation to list all uploaded XML's for the defined date

GET https://api.mediablob.com/api/xml/{date}

Headers

Name

Type

Description

Id: SessionId for the message. File: Link to the upoaded file. Result: Route to retrieve the result file. See for more information. Errors:

/api/auth

Validate authentication and fetch environment information

GET https://api.mediablob.com/api/auth/me

Can be used to fetch information about the environment node structure. Such as customerIds, available languageCodes/countryCodes.

/api/status

Operation to check if the XML processing is done

GET https://api.mediablob.com/api/status/{sessionId}/done

{sessionId} corresponds to the hashcode returned by a 202 Accepted response in

Operation to get a detailed information about the XML process

GET https://api.mediablob.com/api/status/{sessionId}/result

{sessionId} corresponds to the hashcode returned by a 202 Accepted response in

Response header contains a parameter "Location". The parameter contains an URL to the error message.

/api/images

Upload images

POST https://api.mediablob.com/api/images

Upload one or more images to Mediablob as multipart form data objects. If this image already exists, the In C# you need to add the images to a MultipartFormDataContent object, which you add to an HttpClient call. The response contains the Mediablob id for each image, which you can use to reference the images in further integrations. If your image has a clipping path you can add these parameters to the call to tell our rest endpoint which clipping path you want to use. The invert parameter is there to make it possible to invert the clipping path.

Query Parameters

Name

Type

Description

Headers

Name

Type

Description

Request Body

Name

Type

Description

Check if an image exists

HEAD https://api.mediablob.com/api/images/{Mediablob-hashcode}

Verify that an image exists in Mediablob by using the Mediablob-hashcode that was returned when the image was originally uploaded.

Headers

Name

Type

Description

Find the Mediablob hashcode for an uploaded image

GET https://api.mediablob.com/api/images

Find the Mediablob-hashcode for an image that has been previously uploaded. You need to provide one of md5 or uri query parameter, but not both in the request. The Mediablob-hashcode is returned in the response if it is successful, which you can use to reference the image in further integrations.

Query Parameters

Name

Type

Description

Headers

Name

Type

Description

SOAP (legacy)

Legacy

While our SOAP based webservice will remain in operation for some time longer, it is no longer being maintained and will not be updated with bug fixes, etc. If you are already using the SOAP based service we recommend that you switch over to using our REST based service at your earliest convenience. If you are integrating your system to ours for the first time, we strongly urge you to use the REST based service, not the SOAP based one.

The SOAP specific documentation will remain online as long as we accept SOAP requests, only as a convenience to our customers currently using it. Again, if you are building a new integration, use REST instead.

SOAP

Soap is a standard protocol that will not be discussed in detail here. There are some peculiarities to know about when integrating with Mediablob though; specifically Mediablobs use of an <AuthHeader /> section.

Another quirk, that is handled automatically by tools such as Visual Studio, is that xml content must be xml-encoded.

The AuthHeader

Mediablob does not use any cookies or other common login mechanisms to validate access. Instead Mediablob expects an AuthHeader section in the soap header.

The AuthHeader looks like this:

The username and password authenticates the user. Mediablob then verifies the users privileges and authorizes the rest of the request.

The customerId is used to instruct Mediablob which customer node the uploaded xml file relates to. The customerId can either be a ShoppaID assigned by Shoppa when the customer node was created, or an ExternalID assigned to each store by the customer.

Contact Shoppa Service Center to change what ExternalID to use for different stores.

The customerId must always be for or below the node the user logs in to. To prevent pre-generated xml-files to be uploaded to the wrong account by mistake, the customerId must correspond with the customerId of the uploaded xml file.

Encoding

The content of any xml element must be xml encoded. This is achieved by replacing each character with its encoded counterpart. Thus, in the Mediablob product xml you would need to encode the product text Köp & vinn! as Köp & vinn!.

Xml encoding is automatically handled by high-level frameworks like C# and Java. You only need think about this when you create your xml file manually.

What can be a bit confusing is when you wrap the Mediablob xml in soap. Since your xml file is content in a soap element, it needs to be xml encoded, including any text you encoded inside your xml. The product text above would then become Köp &amp; vinn!.

Mediablob also requires an xml declaration line at the top.

Example SOAP Request

Lets say we want to upload the following product definition:

Using the following user details:

username: demouser1
password: Not_a_real_password
ShoppaID: 1143

Encoded and wrapped in a valid soap request this becomes:

Copy this text and POST it with Wizdler to Mediablobs development endpoint. You should get the following response with status code 200 if you did it right:

Pictures

As stated before, any product field can have one picture assigned to it. The same picture can be referenced by many fields, and many products, in several languages.

Pictures are uploaded to Mediablob by calling UploadImage2 or UploadAndClipImage. When an image is uploaded, its md5 hashCode is returned. Use this hashCode as future reference in products.

To reduce bandwidth usage, api users are encouraged to calculate the md5 hash code themselves and check if the image exists in Mediablob through the ImageExists or ImageExistsMd5 functions prior to uploading images.

Note: Images are always hashed before being processed by Mediablob services, so it can be correctly precalculated before uploading.

Note: It is not possible to delete images in Mediablob through the API.

UploadImage

XML structure

XSD

List of all available schema versions for each XML type.

Mediablob.xml

mediablob-v1.1.xsd

StoreInfo.xml

Productgroup.xml

Signorder.xml

REST

All endpoints use a leaky bucket queue algorithm. There is a max capacity of 50 messages at a time with a renewal of 1 message per 5 seconds.

/api/xml

Used for uploading Shoppa XML's to the integration service bus queue

PUT https://api.mediablob.com/api/xml

Available Shoppa XML's can be found at

Headers

Name

Type

Description

Request Body

Name

Type

Description

SessionId example:

Used for uploading a custom XML to the integration service

PUT https://api.mediablob.com/api/xml/custom

Headers

Name

Type

Description

Request Body

Name

Type

Description

SessionId example:

Operation to list all uploaded XML's for the defined date

GET https://api.mediablob.com/api/xml/{date}

Headers

Name

Type

Description

Id: SessionId for the message. File: Link to the upoaded file. Result: Route to retrieve the result file. See for more information. Errors:

/api/auth

Validate authentication and fetch environment information

GET https://api.mediablob.com/api/auth/me

Can be used to fetch information about the environment node structure. Such as customerIds, available languageCodes/countryCodes.

/api/status

Operation to check if the XML processing is done

GET https://api.mediablob.com/api/status/{sessionId}/done

{sessionId} corresponds to the hashcode returned by a 202 Accepted response in

Operation to get a detailed information about the XML process

GET https://api.mediablob.com/api/status/{sessionId}/result

{sessionId} corresponds to the hashcode returned by a 202 Accepted response in

Response header contains a parameter "Location". The parameter contains an URL to the error message.

/api/images

Upload images

POST https://api.mediablob.com/api/images

Query Parameters

Name

Type

Description

Headers

Name

Type

Description

Request Body

Name

Type

Description

Check if an image exists

HEAD https://api.mediablob.com/api/images/{Mediablob-hashcode}

Verify that an image exists in Mediablob by using the Mediablob-hashcode that was returned when the image was originally uploaded.

Headers

Name

Type

Description

Find the Mediablob hashcode for an uploaded image

GET https://api.mediablob.com/api/images

Query Parameters

Name

Type

Description

Headers

Name

Type

Description

Future price changes

Future price changes requires the use of StoreInfo schema version 1.6 or higher and is only supported by Shoppa versions 2.25 or higher.

Changing the price for a later date

Assume we have the following base price list to begin with. It has a start date of 2020-01-01

From 2020-01-15 we want to increase the price of product 111111 to 59.95 SEK. We also want to lower the price of 222222 to 19.95 and 444444 to 69.95 two weeks later.

Here we have to refer to the same package ID as the base price list if the changes are to be combined with the base price list at desired change date. Each package startdate in the XML defines when the changes will apply.

We have therefore created one package with startdate 2020-01-15 and one with startdate 2020-02-01 for the respective price changes.

The price of the product 333333remains the same at each change date.

Periodically changed price

If we want to reduce a price during a short period of time, for e.g. under a two month time. Afterwards we are to set the old price back again. We can not set a stopdate for the reduced price, instead we have to send the higher price on new.

The product will now be on a reduced priced during the two months between 2020-02-01 and 2020-03-31. At 2020-04-01 th eproduct will return to its original price.

Deleting future price changes

It is possible to remove a previously uploaded package in case it was incorrect. This will remove all price changes that were set to occur at the specific date.

We delete the price changes above for 2020-02-01 with this xml:

The price change at 2020-01-15 will still be in effect.

To remove individual products from future price changes, use the delete attribute on the product element, like so:

We have now deleted the change for product 444444.The change for product 222222 at 2020-02-01 will still remain.

Removing all future price changes for a product

Here we will send in a few price changes for the product 111111 over a period of time. We will have price changes at each package startdate.

To remove all future price changes for product 111111we have to delete the product from each future price change package with the same startdate defined as when the change were to occur. The XML will look like this:

Assuming we don't know when all the price changes for a product occurs, we can delete all prices for a product by sending in the product with an empty price value. The startdate of the package will determine from which date the prices are deleted.

All future price changes and the current price for product 111111 are now deleted, starting 2020-01-15.

Correct a future price change

Here we have a price change for 2020-02-01. After a while it is decided that the product should have another price from the same startdate. Correcting the price change is accomplished by setting the new price for the same startdate.

At 2020-02-01 the product will now have a price of 24.95 instead of the original 19.95.

Replacing an entire pricelist

Some time passes and we have made multiple changes to our pricelists at different times. For some reason we may have the need to replace all prices in a pricelist with new prices. Some products may no longer be relevant for example. We do this by setting the fullPackage attribute like this:

Now there will no longer be a price for product 333333 or 444444 starting from 2020-04-15.

Error messages

If the received XML-messages are malformed, or something goes wrong during processing of the message, an error message will be returned by our integration service. This document covers the most common error messages. Unexpected faults might produce unknown exceptions which are not covered by this document.

Error messages are reported in one of two ways: as XML or as plain strings. Problems with file contents are generally reported as XML, while other problems, such as authentication and connectivity issues are reported as strings. Error messages are contained in the <UploadProductXmlResult>-tag.

Example of XML-reported error; trying to add a product that does not exist to a campaign:

Example of string-reported error; wrong password was used:

XML-reported errors

The picture at '*' could not be retrieved.

The picture at the specified URL could not be retrieved. The reason is stated in the error text. Here are some example error texts:

The picture at '*' could not be retrieved. Reason: The remote server returned an error: (404) Not Found.
The picture at '*' could not be retrieved. Reason: Invalid URI: The format of the URI could not be determined.
The picture at '*' could not be retrieved. Reason: Byte array for GUID must be exactly 16 bytes long.

Recommended actions:

The remote server returned an error: (404) Not Found.: Verify that the URL is working and is reachable by our service.
Lost connection to MySQL server during query: Our service is not responding properly. Wait a few minutes and try again.
Lost connection to backend server.: Our service is not responding properly. Wait a few minutes and try again.

Example XML excerpt:

The supplied picture hashcode does not match any known Mediablob picture

Error text: "The supplied picture hashcode (*) does not match any known Mediablob picture"

The hashcode doesn't match any picture in Mediablob.

Recommended action: Make sure the picture is uploaded before trying to assign it to a product.

Example XML excerpt:

Product does not exist in Mediablob

Error text: "Product does not exist in Mediablob"

You're trying to include a non-existing product in a campaign or price list.

Recommended action: Make sure the product is created before adding it to campaigns/price lists.

Example XML excerpt:

Product does not exist

Error text: "Product does not exist"

You’re trying to delete a product that does not exist, or add a product that does not exist to a product group.

Recommended actions:

Deleting a product: The product is already deleted, or never existed. If possible, revise your integration system to avoid deleting already deleted products.
Adding to product group: Make sure the product is created before adding it to product groups.

Example XML excerpt (campaign/price list):

Example XML excerpt (product group):

Product is a duplicate

Error text: "Product is a duplicate"

The product appears twice in a campaign or price list.

Recommended action: If possible, revise your integration system to avoid sending the same product twice or more in the same context (same campaign, product import, etc.).

Example XML excerpt:

Failed to Save the product

Error text: "Failed to Save the product"

The product could not be saved, probably because of something that happened serverside.

Recommended action: Wait a while and resend your data.

Example XML excerpt:

Found 2 products

Error text: "Found 2 products"

When trying to add a product to a product group, two products with the same code were found.

Recommended action: Resolve the conflict, or use a different code to add the product to the product group.

Example XML excerpt:

Product has duplicates in the Xml file. The first copy of the product is saved.

Error text: "Product has duplicates in the Xml file. The first copy of the product is saved."

The same product appears multiple times in a product import. Only the first appearance of the product is used, the other ones are discarded.

Recommended action: If possible, revise your integration system to avoid sending the same product twice or more in the same context (same campaign, product import, etc.).

Example XML excerpt:

The product already belongs to another supplier.

Error text: "The product already belongs to another supplier."

You are trying to modify, or superimpose a value on, a code on a product that does not belong to the customer node you are integrating to. E.g. a store cannot change a code on a product that is owned by their HQ.

Recommended action: If possible, revise your integration system to not attempt to modify codes on lower levels in the customer hierarchy than the product is created on.

Example XML excerpt:

Found existing product in database using the same product code

Error text: Found existing product in database using the same product code: CodeType '*', Value '*'. Product codes must be unique.

You are trying to assign a code to a product, but the code is already used on another product in Mediablob.

Recommended action: If possible, revise your integration system to avoid this behaviour.

Example XML excerpt:

Found duplicate code

Error text: Found duplicate code: CodeType '*', Value '*'. Product codes must be unique.

You are trying to assign the same code to multiple products within the same file.

Recommended action: If possible, revise your integration system to avoid this behaviour.

Example XML excerpt:

String-reported errors

User is not authenticated.

Error text: "User is not authenticated."

The authentication provided in the SOAP-object is not valid.

Recommended action: Verify that you are using the correct login information.

Either uri or keyword MUST be set on a product picture

Error text: "Either uri or keyword MUST be set on a product picture."

There is a picture tag that lacks 'uri', 'hashCode' and 'md5' attributes. One of them must be present to successfully reference a picture.

Recommended action: If possible, revise your integration system to avoid this behaviour.

Object reference not set to an instance of an object

Error text: "Object reference not set to an instance of an object."

The imported XML does not contain any information.

Example of imported XML:

Recommended action: If possible, revise your integration system to avoid sending anything if there is no data to send.

Failed to save picture '*'

Error text: "Failed to save picture '*'. The picture might be corrupt, try uploading the picture again or use another picture."

Something went wrong when uploading one or more pictures. Several instances can be present in the same response.

Recommended action: Try uploading the picture again.

Example:

Syntax error

Error text: "*. Line *, position *."

There is a syntax error in the imported XML. This is typically caused by unescaped special characters: '&', '<' and '>'. See the section for more details.

Recommended action: Make sure you are encoding special characters correctly: once to get them into the import XML and then once again to get them into the SOAP-object.

Example:

Guid *

Error text: "Guid *"

You have done too many revisions and the version number has gone out of bounds.

Recommended action: Contact Shoppa.

Example:

Validation error

Error text: "Line: *, Position: * "*""

The imported XML does not match the XML-schema.

Recommended action: Adjust the generation of the XML content according to the given reason.

Example:

Deadlock found when trying to get lock

Error text: "Deadlock found when trying to get lock; try restarting transaction"

Something went wrong serverside.

Recommended action: Wait a while and resend your data.

Connection must be opened

Error text: "Connection must be opened."

Something went wrong serverside.

Recommended action: Wait a while and resend your data.

Lost connection to MySQL server during query

Error text: "Lost connection to MySQL server during query"

Something went wrong serverside.

Recommended action: Wait a while and resend your data.

Failed to create new session

Error text: "failed to create new session"

Something went wrong serverside.

Recommended action: Wait a while and resend your data.

Exception has been thrown by the target of an invocation

Error text: "Exception has been thrown by the target of an invocation."

Something went wrong serverside.

Recommended action: Wait a while and resend your data.

Lost connection to backend server

Error text: "Lost connection to backend server."

Something went wrong serverside.

Recommended action: Wait a while and resend your data.

An exception occured that could not be fully serialized

Error text: "An exception occured that could not be fully serialized: Exception has been thrown by the target of an invocation."

Something went wrong serverside.

Recommended action: Wait a while and resend your data.

API Documentation

What is Mediablob

hashtagThe customer node

hashtagThe Product object

hashtagThe StoreInfo object

Fields

hashtagRequired fields

hashtagCode fields

hashtagText fields

hashtagPrice fields

hashtagPicture fields

hashtagAdditional fields

Endpoints

hashtagHTTPS endpoints

hashtagREST/HTTP Developer tools

hashtagLegacy SOAP endpoints

hashtagSOAP Developer tools

hashtagHow to use the endpoints properly

hashtagRequesting user access

Authorization

hashtagIntegration user

hashtagCustomer nodes

REST

hashtag/api/xml

hashtagUsed for uploading Shoppa XML's to the integration service bus queue

hashtagHeaders

hashtagRequest Body

hashtagUsed for uploading a custom XML to the integration service

hashtagHeaders

hashtagRequest Body

hashtagOperation to list all uploaded XML's for the defined date

hashtagHeaders

hashtag/api/auth

hashtagValidate authentication and fetch environment information

hashtag/api/status

hashtagOperation to check if the XML processing is done

hashtagOperation to get a detailed information about the XML process

hashtag/api/images

hashtagUpload images

hashtagQuery Parameters

hashtagHeaders

hashtagRequest Body

hashtagCheck if an image exists

hashtagHeaders

hashtagFind the Mediablob hashcode for an uploaded image

hashtagQuery Parameters

hashtagHeaders

SOAP (legacy)

hashtagLegacy

hashtagSOAP

hashtagThe AuthHeader

hashtagEncoding

hashtagExample SOAP Request

Pictures

hashtagUploadImage

XML structure

XSD

Authorization

hashtagIntegration user

hashtagCustomer nodes

Fields

hashtagRequired fields

hashtagCode fields

hashtagText fields

hashtagPrice fields

hashtagPicture fields

hashtagAdditional fields

SOAP (legacy)

hashtagLegacy

hashtagSOAP

hashtagThe AuthHeader

hashtagEncoding

hashtagExample SOAP Request

What is Mediablob

hashtagThe customer node

hashtagThe Product object

hashtagThe StoreInfo object

Endpoints

hashtagHTTPS endpoints

hashtagREST/HTTP Developer tools

The customer node

The Product object

The StoreInfo object

Required fields

Code fields

Text fields

Price fields

Picture fields

Additional fields

HTTPS endpoints

REST/HTTP Developer tools

Legacy SOAP endpoints

SOAP Developer tools

How to use the endpoints properly

Requesting user access

Integration user

Customer nodes

/api/xml

Used for uploading Shoppa XML's to the integration service bus queue

Headers

Request Body

Used for uploading a custom XML to the integration service

Headers

Request Body

Operation to list all uploaded XML's for the defined date

Headers

/api/auth

Validate authentication and fetch environment information

/api/status

Operation to check if the XML processing is done

Operation to get a detailed information about the XML process

/api/images

Upload images

Query Parameters

Headers

Request Body

Check if an image exists

Headers

Find the Mediablob hashcode for an uploaded image

Query Parameters

Headers

Legacy

SOAP

The AuthHeader

Encoding

Example SOAP Request

UploadImage

Integration user

Customer nodes

Required fields

Code fields

Text fields

Price fields

Picture fields

Additional fields

Legacy

SOAP

The AuthHeader

Encoding

Example SOAP Request

The customer node

The Product object

The StoreInfo object

HTTPS endpoints

REST/HTTP Developer tools

Legacy SOAP endpoints

SOAP Developer tools

How to use the endpoints properly

Requesting user access

/api/xml

Used for uploading Shoppa XML's to the integration service bus queue

Headers

Request Body

Used for uploading a custom XML to the integration service

Headers

Request Body

Operation to list all uploaded XML's for the defined date

Headers

/api/auth

Validate authentication and fetch environment information