DeliveryStop

Remove delivery stops

The user needs to be logged in to use this endpoint, click here to read more.

It is possible to delete a future stopp, i.e the stop periode can not be activated.

The endpoint returns a list of remaining furture stops after removed the furture stop you have chosen.

SecurityAuthorization_Code
Request
path Parameters
id
required
integer

The unique id for the stop you want to delete.

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/product/stop/delivery/delete/{id}
Request samples
Response samples
application/json
{
  • "deliveryStops": [
    ]
}

Register delivery stops

The user needs to be logged in to use this endpoint, click here to read more.

Stop API for stopping delivery to a customer permanently or temporary.

SecurityAuthorization_Code
Request
Request Body schema: application/json
object
Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

post/v1/product/stop/delivery
Request samples
application/json
{
  • "deliveryStop": {
    }
}
Response samples
application/json
{
  • "deliveryStops": {
    }
}

List delivery stops

The user needs to be logged in to use this endpoint, click here to read more.

API is used to get stop registered on customer.

SecurityAuthorization_Code
Request
path Parameters
productCode
required
string <= 12 characters

Product code

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/product/stop/delivery/{productCode}
Request samples
Response samples
application/json
{
  • "deliveryStops": [
    ]
}

List delivery stop - client mode

API is used to get stop registered on customer.

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

SecurityClient_Credentials
Request
path Parameters
customerNumber
required
integer

Customer number linked to product delivery

productCode
required
string <= 12 characters

Product code

Responses
200

OK

Response Schema: application/json
Array of objects
400

Bad Request

429

Too Many Requests

500

Internal Server Error

get/v1/client/product/stop/delivery/{customerNumber}/{productCode}
Request samples
Response samples
application/json
{
  • "deliveryStops": [
    ]
}