BokaMera.API.Host

<back to all web services

UpdateArticleMappings

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/articles/mappingsUpdate external article mappings for the company articlesCreate or update mappings between BokaMera articles and articles in an external system, for example e-accounting
UpdateArticleMappings Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoCompany to update article mappings for
ArticleMappingsbodyList<ArticleMappingToHandle>YesThe article mappings to create or update
ArticleMappingToHandle Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?NoThe id of an existing mapping to update; leave empty to create a new one
ArticleIdformintNoThe BokaMera article id
ReferenceTypeformstringYesThe Reference Type: StripeArticle = 1, EAccountingArticle = 2
ExternalReferenceformstringYesThe external reference; Values for EAccountingArticle, StripeArticle

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /articles/mappings HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","ArticleMappings":[{"Id":"00000000-0000-0000-0000-000000000000","ArticleId":0,"ReferenceType":"String","ExternalReference":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"ArticleId":0,"ExternalReference":"String","ReferenceType":"String"}]