API

Product APIs

POST product/shared-product-publishers

Create shared product publishers for the provided identifier

HTTP method POST
URI https://api.rambase.net/product/shared-product-publishers
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 7169, version 1

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<SharedProductPublisher>
2
     <Publisher
Publisher

Required/mandatory field

Company details of the publisher. The company that is setup to publish to shared products when e.g. a local product is activated.

>
3
          <CompanyId
CompanyId

Required/mandatory field

Company identifier

Minimum value: 100

>{Integer}</CompanyId>
4
     </Publisher>
5
</SharedProductPublisher>
1
{
2
     "sharedProductPublisher": {
3
          "publisher
Publisher

Required/mandatory field

Company details of the publisher. The company that is setup to publish to shared products when e.g. a local product is activated.

": {
4
               "companyId
CompanyId

Required/mandatory field

Company identifier

Minimum value: 100

": "{Integer}"
5
          }
6
     }
7
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$showDomainDescriptions Boolean, optional Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<SharedProductPublisher>
2
     <SharedProductPublisherId
SharedProductPublisherId

Shared product publisher identifier

>{Integer}</SharedProductPublisherId>
3
     <Status
Status

Status of the shared product publisher

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Publisher
Publisher

Company details of the publisher. The company that is setup to publish to shared products when e.g. a local product is activated.

>
6
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
7
          <Name
Name

Name of company

>{String}</Name>
8
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
9
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
10
     </Publisher>
11
     <ProductTypes>
12
          <ProductType>
13
               <Type
Type

Product type that will be published

Possible domain values can be found here

>{String}</Type>
14
          </ProductType>
15
     </ProductTypes>
16
</SharedProductPublisher>
1
{
2
     "sharedProductPublisher": {
3
          "sharedProductPublisherId
SharedProductPublisherId

Shared product publisher identifier

": "{Integer}",
4
          "status
Status

Status of the shared product publisher

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "publisher
Publisher

Company details of the publisher. The company that is setup to publish to shared products when e.g. a local product is activated.

": {
7
               "companyId
CompanyId

Company identifier

": "{Integer}",
8
               "name
Name

Name of company

": "{String}",
9
               "database
Database

Abbreviation/code to identify the company

": "{String}",
10
               "companyLink
CompanyLink

Company reference

": "{String}"
11
          },
12
          "productTypes": [
13
               {
14
                    "type
Type

Product type that will be published

Possible domain values can be found here

": "{String}"
15
               }
16
          ]
17
     }
18
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 100027 HTTP 400 Missing mandatory parameter {0}
Error 101420 HTTP 404 Setting definition not found
Error 110230 HTTP 400 Shared product publisher is required