B2B Marketplace service endpoints¶
- For general information see How to work with the B2B marketplace service.
- Technical definitions of each API, sample code, test UI and Open API definitions to download you can find in the developer portal.
-> developer.discover.swiss/apis
General headers¶
| Header Name | Type | Description |
|---|---|---|
| Ocp-Apim-Subscription-Key | string | Appropriate subscription key you can get in the developer portal |
| partner-request | string | Partner acronym |
| Accept-Timezone | string | Supply a TimeZone id property acquired from Infocenter /timezones route in order to get data with desired time offset. The default is UTC. |
Business trail¶
| url | verb | request | response | description |
|---|---|---|---|---|
| /businesstrail | POST | BusinessTrail | empty | Creates a new Business-trail entry or returns BadRequest and validation messages |
Order (shopping cart)¶
| url | verb | request | response | description |
|---|---|---|---|---|
| /orders | POST | Order | OrderResponse | if the object is technically correct it is created even when there are validation errors |
| /orders/{id} | PUT | Order | OrderResponse | if the object is technically correct it is updated even when there are validation errors |
| /orders/{id} | GET | id (orderNumber) | OrderResponse | Can be used to poll the order state or to get other known orders |
| /orders/{id} | DELETE | id (orderNumber) | 200: - error: OrderResponse |
depending on the state of the order it removes it from the database or sets the state to deleted or cancelled. |
| /orders/{id}/payment | PUT | PaymentRequest | 200: - PaymentResponse |
If there are validation errors, http status code will be 400.
OrderResponse¶
| Property | Type | Description |
|---|---|---|
| validationMessages | ValidationMessage[] | messages from the state machine |
| terms | TermVersion[] | terms to accept in the TermVersionCheck objects of the order |
| order | Order | json-ld: full url to load the object (based on orderNumber) |
PaymentRequest¶
| Property | Type | Description |
|---|---|---|
| reference | string | Any description. It would be set in payment details of the order |
PaymentResponse¶
| Property | Type | Description |
|---|---|---|
| validationMessages | ValidationMessage[] | messages from the state machine |
| PaymentData | OrderPaymentDetailsResponse | The resulting object in the state before the order is processed. With set paymentType and reference |
OrderPaymentDetailsResponse¶
| Property | Type | Description |
|---|---|---|
| PaymentType | string | Type of payment. (B2B) |
Accept terms¶
To accept the terms and conditions inside the order and any time during the process.
This endpoint is using the same objects like the terms-endpoint in the profile service.
| url | verb | request | response |
|---|---|---|---|
| /orders/{id}/terms/{termCode} | PUT | TermVersionCheckRequest | TermVersionCheck |
Info
Accepting the terms by using this call does not change the state of the order.
Last update: May 11, 2021 10:20:11