Offer

Endpoints for Offer addon

Offer addon

post

Create a offer request

Authorizations

ApiKey

sw-context-tokenstringRequired

Body

application/json

billigAddressIdstringOptional

deliverAddressIdstringOptional

subjectstringOptional

commissionstringOptional

customerCommentstringOptional

Responses

200Success

No content

post

/offer-request

HTTPcURLJavaScriptPython

POST /offer-request HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "billigAddressId": "text",
  "deliverAddressId": "text",
  "subject": "text",
  "commission": "text",
  "customerComment": "text"
}

200Success

No content

post

Create a offer item request

Authorizations

ApiKey

sw-context-tokenstringRequired

Body

application/json

billigAddressIdstringOptional

deliverAddressIdstringOptional

subjectstringOptional

commissionstringOptional

customerCommentstringOptional

Responses

200Success

No content

post

/offer-item-request

HTTPcURLJavaScriptPython

POST /offer-item-request HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "billigAddressId": "text",
  "deliverAddressId": "text",
  "subject": "text",
  "commission": "text",
  "customerComment": "text",
  "lineItems": [
    {
      "id": "text",
      "productId": "text",
      "quantity": 1,
      "comment": "text"
    }
  ]
}

200Success

No content

get

Get reffered product

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

productIdstringRequired

ID of product

Responses

200

Order

application/json

anyOptional

get

/b2b/offer-reference-product/{productId}

HTTPcURLJavaScriptPython

GET /b2b/offer-reference-product/{productId} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

Order

No content

Converts an offer into an order

post

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer

Responses

200

Order

application/json

anyOptional

post

/offer-order/{id}

HTTPcURLJavaScriptPython

POST /offer-order/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

Order

No content

post

Request validity for an offer

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

post

/offer/{id}/request-validity-extension

HTTPcURLJavaScriptPython

POST /offer/{id}/request-validity-extension HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

Returns a success response indicating a successful update

No content

post

list offer states

Authorizations

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

post

/offer-states

HTTPcURLJavaScriptPython

POST /offer-states HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

get

gets a document related to an offer

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of document

Responses

200

the document

No content

get

/offer-document/{id}

HTTPcURLJavaScriptPython

GET /offer-document/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

the document

No content

Get event mail

get

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer mail

Responses

200Success

No content

get

/offer-mail/{id}

HTTPcURLJavaScriptPython

GET /offer-mail/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

Send offer mail

post

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer

Responses

200

Returns a success response indicating a successful send

application/json

anyOptional

post

/offer-mail/{id}

HTTPcURLJavaScriptPython

POST /offer-mail/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

Returns a success response indicating a successful send

No content

get

Get a offer

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer

Responses

200Success

No content

get

/offer/{id}

HTTPcURLJavaScriptPython

GET /offer/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

put

Update a offer

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer

Body

application/json

anyOptional

Responses

200Success

No content

put

/offer/{id}

HTTPcURLJavaScriptPython

PUT /offer/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*

200Success

No content

delete

Delete a offer

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

delete

/sales-representative/offer/{id}

HTTPcURLJavaScriptPython

DELETE /sales-representative/offer/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200

Returns a success response indicating a successful update

No content

List offers

post

Authorizations

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

post

/offer/list

HTTPcURLJavaScriptPython

POST /offer/list HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

List offers

get

Authorizations

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

get

/offer/

HTTPcURLJavaScriptPython

GET /offer/ HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

No content

create new offer

post

Authorizations

ApiKey

sw-context-tokenstringRequired

Body

application/json

anyOptional

Responses

200Success

No content

post

/offer/

HTTPcURLJavaScriptPython

POST /offer/ HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*

200Success

No content

Clone an offer

post

This route is used to clone a Offer

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

idstringRequired

ID of offer

Responses

200Success

No content

post

/sales-representative/clone-offer/{id}

HTTPcURLJavaScriptPython

POST /sales-representative/clone-offer/{id} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

200Success

No content

post

Add items to an offer

Authorizations

ApiKey

sw-context-tokenstringRequired

Path parameters

offerIdstringRequired

ID of offer

Body

application/json

objectB2bsellersOfferItem[]Optional

Responses

200

Returns a success response indicating a successful update

application/json

anyOptional

post

/offer-add-products/{offerId}

HTTPcURLJavaScriptPython

POST /offer-add-products/{offerId} HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "object": []
}

200

Returns a success response indicating a successful update

No content