Facility discounts endpoints

Create facility discount

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

ID of the facility you want to add the discount to. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Body

application/json

FacilityDiscountForCreation

contextanyOptional

The context of the discount. This is used to determine the conditions under which the discount can be applied.

discountone ofRequired

or

priorityintegerRequired

The priority of the discount. Discounts with the lowest priority value are applied first. Value must be greater than 0 and smaller than 1000.

Example: 1

typestring · enumRequired

Determines the price type this discount can be applied to.

Possible values:

Responses

201

The discount was successfully created. The Location header contains the URL of the discount.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Facility not found

application/json

post

/api/facilities/{facilityRef}/discounts

HTTPcURLJavaScriptPython

POST /api/facilities/{facilityRef}/discounts HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 155

{
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "priority": 1,
  "type": "SALES_PRICE"
}

{
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "facilityRef": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "id": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "priority": 1,
  "type": "SALES_PRICE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List facility discounts

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

ID of the facility you want to get the discounts for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of facilities to show

Default: 25

Responses

200

The discounts were successfully retrieved. The result is in the body.

application/json

anyOptional

FacilityDiscountPaginatedResult

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Facility not found

application/json

get

/api/facilities/{facilityRef}/discounts

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityRef}/discounts HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[]

Get facility discount

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

ID of the facility you want to get the discount for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

facilityDiscountRefstringRequired

ID of the discount you want to get

Responses

200

The discount was successfully retrieved. The result is in the body.

application/json

FacilityDiscount

and

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Facility or discount not found

application/json

get

/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "facilityRef": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "id": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "priority": 1,
  "type": "SALES_PRICE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete facility discount

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

ID of the facility you want to delete the discount from. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

facilityDiscountRefstringRequired

ID of the discount you want to delete

Responses

200

The discount was successfully deleted. The result is in the body.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Facility or discount not found

application/json

delete

/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

HTTPcURLJavaScriptPython

DELETE /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update facility discount

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityRefstringRequired

ID of the facility you want to update the discount for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

facilityDiscountRefstringRequired

ID of the discount you want to update

Body

application/json

FacilityDiscountForUpdate

contextanyOptional

The context of the discount. This is used to determine the conditions under which the discount can be applied.

discountone ofOptional

or

priorityintegerOptional

The priority of the discount. Discounts with the lowest priority value are applied first. Must be greater than 0 and smaller than 1000.

Example: 1

typestring · enumOptional

Determines the price type this discount can be applied to.

Possible values:

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

200

The discount was successfully updated. The result is in the body.

application/json

FacilityDiscount

and

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Facility or discount not found

application/json

patch

/api/facilities/{facilityRef}/discounts/{facilityDiscountRef}

HTTPcURLJavaScriptPython

PATCH /api/facilities/{facilityRef}/discounts/{facilityDiscountRef} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 168

{
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "priority": 1,
  "type": "SALES_PRICE",
  "version": 42
}

{
  "discount": {
    "type": "RELATIVE",
    "value": 7.1
  },
  "facilityRef": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "id": "5d35d4b8-8a07-40c5-8486-eae2de902597",
  "context": [
    {
      "operator": "NOT",
      "type": "FACILITY",
      "values": [
        "uuid-bkrs-0157"
      ]
    }
  ],
  "priority": 1,
  "type": "SALES_PRICE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}