Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zalando

Zalando offer-blockers API

The offer-blockers API from Zalando — 2 operation(s) for offer-blockers.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zalando offer-blockers API is one of 20 APIs that Zalando publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include offer-blockers. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 4 operations across 2 paths, and defines 27 schemas. It is described by OpenAPI 3.0.2, at version 1.0.0.

Requests are made against the base URL https://api.merchants.zalando.com.

4 operations 2 paths 27 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://api.merchants.zalando.com
Resource Areas
1

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

offer-blockers 4
POST
/merchants/{merchant-id}/offer-blockers
Create Offer Blockers.
1 param body → 207default
GET
/merchants/{merchant-id}/offer-blockers
List Offer Blockers.
7 params → 200default
DELETE
/merchants/{merchant-id}/offer-blockers
Delete Offer Blockers.
1 param body → 207default
GET
/merchants/{merchant-id}/offer-blockers/{offer-blocker-id}
Get details about an Offer Blocker.
2 params → 200default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are ListOfferBlockersQuery (5 properties), NewProductBlocker (4 properties), OfferBlocker (4 properties), NewOfferBlocker (4 properties). Each schema is shown below with its type and property counts.

Cursor
string
A value indicating that there are more results than could be returned immediately. Pass it in the next request to get the next batch of results. If there is no…
NewProductBlocker
object
4 properties 2 required
Cursors
object
There are three cursor directions available: - self: returns the current batch - prev: returns the previous batch - next: returns the next batch
2 properties 1 required
CursorUrl
string
The location where you can find the next selected batch of Offer Blockers.
CreateOfferBlockersRequest
object
1 property 1 required
NewOfferBlocker
object
4 properties 2 required
OfferBlocker
object
4 properties 3 required
OfferBlockerCriteria
object
Criteria describing which articles are blocked by this Offer Blocker. Any combination of conditions can be provided. They are combined using logical "AND". If…
2 properties
ProductOfferBlockerCriteria
object
Criteria describing which articles are blocked by this Offer Blocker. The EAN is required. Criteria are combined using logical "AND".
2 properties 2 required
UpdatedSince
string
If set, the response will only contain Offer Blockers which were created or updated after this time. The date-time format is defined as in RFC 3339, section 5.…
OfferBlockerId
string
The ID of the Offer Blocker.
SalesChannelId
string
The ID of the Sales Channel.
ListOfferBlockersResponse
object
3 properties 3 required
CreateOfferBlockersResponse
object
1 property 1 required
PageSize
integer
A positive value indicating how many results should be returned for one request.
OfferBlockerDescription
string
Human-readable description explaining why this blocker exists. You can include any identifier in the description to distinguish the blocker source (e.g., syste…
ListOfferBlockersQuery
object
Object containing the query filters applied in the search request to filter Offer Blockers.
5 properties
DeleteOfferBlockersRequest
object
1 property 1 required
DeleteOfferBlockersResponse
object
1 property 1 required
MerchantId
string
The ID of the Merchant.
OfferBlockerReason
string
Indicates result of the Offer Blocker request. - PAUSE01: End of season/removal from assortment - PAUSE02: High return rate - PAUSE03: Stock issue Low sales pe…
NewOfferBlockerId
string
The ID of the newly-created Offer Blocker.
ResponseDescription
string
Detailed message regarding the request status.
ResponseStatus
string
Indicates result of the Offer Blocker request. - ACCEPTED: indicates a successful request. - REJECTED: indicates validation errors where a detailed description…
OfferBlockerResult
object
The result of processing an Offer Blocker request.
2 properties 1 required
Ean
string
Global Trade Item Number (GTIN-13).
UpdatedUntil
string
If set, the response will only contain Offer Blockers which were created or updated before this time. The date-time format is defined as in RFC 3339, section 5…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zalando-offer-blockers-api-openapi.yml Raw ↑

Other APIs Zalando publishes across the network.

Zalando AnnouncedReturns API
AE Profile APIs.io
Zalando attribute-types API
AE Profile APIs.io
Zalando attribute-values API
AE Profile APIs.io
Zalando Attributes API
AE Profile APIs.io
Zalando Cross Border Movements API
AE Profile APIs.io
Zalando Discovery API API
AE Profile APIs.io
Zalando History of Price Update Attempts API
AE Profile APIs.io
Zalando Liquidated Items API
AE Profile APIs.io
Zalando Logistic Centers API
AE Profile APIs.io
Zalando Orders API
AE Profile APIs.io
Zalando Outlines API
AE Profile APIs.io
Zalando prices API
AE Profile APIs.io
#offer-blockers
← Back to Z APIs
API Details
ID
zalando:zalando-offer-blockers-api
Base URL
https://api.merchants.zalando.com
Docs
https://developers.merchants.zalando.com/docs/openapi/orders.html
Provider
Zalando
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network