snabble coupon API (v1)

Download OpenAPI specification:Download

All endpoints require the Authorization header to be set with a valid JWT token for the respective environment. The endpoints are for managing and modifying coupons. This will typically be done by a project admin in the Retailer Portal or by direct access.

public

Public API to manage coupons.

Retrieve the list of coupons

Authorizations:

None

path Parameters

projectID

required

string

ID of the project

Responses

Response samples

200
default

Content type

application/json

{"coupons": [ ],
"links": {"self": {"href": "https://api.snabble.io/project-123/coupons"
}
}
}

Create a new coupon

Authorizations:

None

path Parameters

projectID

required

string

ID of the project

Request Body schema: application/json
required

	object
channels required	Array of strings (CouponChannels) Items Enum: "app" "sco" List of distribution channels
type required	string (CouponType) Discriminator to distinguish different kinds of coupons manual
redeemType	string (CouponRedeemType) Enum: "once-per-scanned-code" "once-per-app-user-id" "multiple" Discriminator to distinguish different ways to redeem a coupon
processingType	string (CouponProcessingType) Enum: "custom" "none" "builtin" How to process coupons
requiresLoyaltyCard	boolean (RequiresLoyaltyCardType) Coupon requires loyalty card for redemption
validFrom	string <date-time> (ValidFrom) The date and time the coupon is valid from (inclusive)
validUntil	string <date-time> (ValidUntil) The date and time the coupon is valid until (inclusive)
	object (AdditionalAttributes) Additional attributes of a coupon

Responses

Request samples

Payload

Content type

application/json

Example

manualDiscount

{"id": "manual-50-percent-discount",
"channels": ["app"
],
"type": "manual",
"redeemType": "multiple",
"processingType": "builtin",
"translations": {"name": {"en": "Discount 50%",
"de": "Rabatte 50%"
},
"description": {"en": "Special discount with a whopping 50%",
"de": "Sonderrabatte mit ganzem 50%"
}
},
"validFrom": "2021-04-26T00:00:00+02:00",
"validUntil": "2021-07-26T00:00:00+02:00"
}

Response samples

201
400
422
default

Content type

application/json

Example

manualDiscount

{"id": "special-offer-123456",
"projectID": "another-project",
"channels": ["app"
],
"type": "manual",
"redeemType": "multiple",
"processingType": "builtin",
"name": "Rabatte 50%",
"description": "Sonderrabatte mit ganzem 50%",
"translations": {"name": {"en": "Discount 50%",
"de": "Rabatte 50%"
},
"description": {"en": "Special discount with a whopping 50%",
"de": "Sonderrabatte mit ganzem 50%"
}
},
"validFrom": "2021-04-26T00:00:00+02:00",
"validUntil": "2021-07-26T00:00:00+02:00",
"links": {"self": {"href": "https://api.snabble.io/project-123/coupons/52e62b18-a69f-11eb-a2ba-a0cec8d18e11"
}
}
}

Retrieve a coupon

Authorizations:

None

path Parameters

projectID required	string ID of the project
couponID required	string ID of a coupon

Responses

Response samples

200
404
default

Content type

application/json

Example

manualDiscount

{"id": "special-offer-123456",
"projectID": "another-project",
"channels": ["app"
],
"type": "manual",
"redeemType": "multiple",
"processingType": "builtin",
"name": "Rabatte 50%",
"description": "Sonderrabatte mit ganzem 50%",
"translations": {"name": {"en": "Discount 50%",
"de": "Rabatte 50%"
},
"description": {"en": "Special discount with a whopping 50%",
"de": "Sonderrabatte mit ganzem 50%"
}
},
"validFrom": "2021-04-26T00:00:00+02:00",
"validUntil": "2021-07-26T00:00:00+02:00",
"links": {"self": {"href": "https://api.snabble.io/project-123/coupons/52e62b18-a69f-11eb-a2ba-a0cec8d18e11"
}
}
}

Update an existing coupon

Authorizations:

None

path Parameters

projectID required	string ID of the project
couponID required	string ID of a coupon

header Parameters

If-Match

required

string

The ETag of the resource. If the provided ETag does not match the current ETag of the resource, the request will fail with a 412 Precondition Failed error. Asterisk is supported as wildcard.

Request Body schema: application/json
required

	object
channels required	Array of strings (CouponChannels) Items Enum: "app" "sco" List of distribution channels
type required	string (CouponType) Discriminator to distinguish different kinds of coupons manual
redeemType	string (CouponRedeemType) Enum: "once-per-scanned-code" "once-per-app-user-id" "multiple" Discriminator to distinguish different ways to redeem a coupon
processingType	string (CouponProcessingType) Enum: "custom" "none" "builtin" How to process coupons
requiresLoyaltyCard	boolean (RequiresLoyaltyCardType) Coupon requires loyalty card for redemption
validFrom	string <date-time> (ValidFrom) The date and time the coupon is valid from (inclusive)
validUntil	string <date-time> (ValidUntil) The date and time the coupon is valid until (inclusive)
	object (AdditionalAttributes) Additional attributes of a coupon

Responses

Request samples

Payload

Content type

application/json

Example

manualDiscount

{"channels": ["app"
],
"type": "manual",
"redeemType": "multiple",
"processingType": "builtin",
"translations": {"name": {"en": "Discount 50%",
"de": "Rabatte 50%"
},
"description": {"en": "Special discount with a whopping 50%",
"de": "Sonderrabatte mit ganzem 50%"
}
},
"validFrom": "2021-04-26T00:00:00+02:00",
"validUntil": "2021-07-26T00:00:00+02:00"
}

Response samples

200
400
412
422
default

Content type

application/json

Example

manualDiscount

{"id": "special-offer-123456",
"projectID": "another-project",
"channels": ["app"
],
"type": "manual",
"redeemType": "multiple",
"processingType": "builtin",
"name": "Rabatte 50%",
"description": "Sonderrabatte mit ganzem 50%",
"translations": {"name": {"en": "Discount 50%",
"de": "Rabatte 50%"
},
"description": {"en": "Special discount with a whopping 50%",
"de": "Sonderrabatte mit ganzem 50%"
}
},
"validFrom": "2021-04-26T00:00:00+02:00",
"validUntil": "2021-07-26T00:00:00+02:00",
"links": {"self": {"href": "https://api.snabble.io/project-123/coupons/52e62b18-a69f-11eb-a2ba-a0cec8d18e11"
}
}
}

Delete an existing coupon

Authorizations:

None

path Parameters

projectID required	string ID of the project
couponID required	string ID of a coupon

header Parameters

If-Match

required

string

The ETag of the resource. If the provided ETag does not match the current ETag of the resource, the request will fail with a 412 Precondition Failed error. Asterisk is supported as wildcard.

Responses

Response samples

412
default

Content type

application/json

{"error": {"type": "string",
"message": "string"
}
}

Upload a new image

Authorizations:

None

path Parameters

projectID

required

string

ID of the project

Request Body schema: multipart/form-data
required

file	string <binary>

Responses

Response samples

201
400
422
default

Content type

application/json

{"ref": "gs://images.snabble.io/project-123/coupons/204cb6b1054699c7c3d2539ae7d783e67fabf38e-example.png"
}

snabble coupon API (v1)

public

Retrieve the list of coupons

Authorizations:

path Parameters

Responses

Response samples

Create a new coupon

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve a coupon

Authorizations:

path Parameters

Responses

Response samples

Update an existing coupon

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an existing coupon

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Upload a new image

Authorizations:

path Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required