Contents x
    promotions
    • 09 Dec 2024
    • Dark
      Light
    Contents

    promotions

    • Updated on 09 Dec 2024
    • Dark
      Light
    Article summary

    Post
    /publisher/{publisherId}/promotions

    This API is Available on Zapier

    Automate your workflows with Zapier's easy to use workflow builder. Read more here or go directly our Zapier Integration Page. 

    POST Offers
    Offers API allows publishers to retrieve details of promotions and voucher codes offered by Advertisers who are part of the Awin network. Publishers can retrieve offers published by advertisers they are both joined and aren't joined to. The data reflects that which is available in "My Offers" section on the Awin UI.
    Due to implemented pagination, there is no limit on the amount of offers that can be retrieved with one API call.

    Who can use it?
    Publishers

    Header parameters
    Authorization
    string

    accessToken

    Path parameters
    publisherId
    integer (int64) Required

    publisherId

    Query parameters
    accessToken
    stringRequired

    access token

    Body parameters

    requestBody

    Expand All
    object
    filters
    object (Filters)
    advertiserIds
    Array of integer
    integer (int32)
    exclusiveOnly
    boolean
    membership
    string
    Valid values[ "\"joined\"", "\"notJoined\"", "\"all\"" ]
    regionCodes
    Array of string
    string
    status
    string
    Valid values[ "\"active\"", "\"expiringSoon\"", "\"upcoming\"" ]
    type
    string
    Valid values[ "\"promotion\"", "\"voucher\"", "\"all\"" ]
    updatedSince
    string
    Exampleyyyy-MM-dd
    pagination
    object (Pagination)
    page
    integer (int32)
    pageSize
    integer (int32)
    Field nameTypeDescription
    advertiserIdsArray of integers
     Limits the response to just the offers belonging to the specified Advertisers.
    exclusiveOnlyBoolean
    		Whether to limit the response to only those offers which are exclusive to your publisher account.
    membershipString
    		Possible values: “all”, “joined”, “notJoined”
     Limits the offers returned based on your Membership status with the Advertiser.
     Default: “all”
    regionCodesArray of Strings
    		This should contain 2-letter country codes (ISO 3166 Alpha-2).
     If this field is present, it limits the response to only offers which are valid in one or more of the specified regions.
    statusString
    		“active”: Offers which are currently valid.
     “expiringSoon”: Offers which are currently valid, but will expire in the next 7 days.
     “upcoming”: Offers which are not yet valid (their startDate is in the future).
     Default: “active”
    typeString
    		Possible values: “promotion”, “voucher”, “all”
     Default: “all”
    updatedSinceString (YYYY-MM-DD)
    		If present, this field will limit the returned offers to only those which have been created or modified since the specified date.
     Example: “2022-05-06”
    pageSizeInteger
    		If present, this field will limit the count of returned offers to the specified number (between 10 and 200) per page. If not specified (up to) 200 offers are returned by default.
     Example: “10” 
    Responses
    200

    OK

    object
    Field nameTypeDescription
    promotionIdInteger
    		The unique ID of the promotion
    typeString
    		Possible values: “promotion” or “voucher”
    advertiserObject
    		id: Integer. The Advertiser ID
     name: String. The Advertiser name
     joined: Boolean. Whether your publisher account has an active membership with this Advertiser.
    titleString
    		The title of the offer
    descriptionStringThe description of the offer
    termsString
    		Terms and conditions relating to this offer
    startDate, endDateString (YYYY-MM-DDT00:00:00.000)
    		Dates defining the offer's active period. Time is in UTC.
    dateAddedString (YYYY-MM-DDT00:00:00.000)The date the offer has been added to the Awin network. Time is in UTC.
    urlString
    		URL of the page where the offer can be found – e.g. a product page.
    urlTrackingString
    		Awin tracking URL to the same page.
    regionsObject
    		all: Boolean. If true, then the offer is applicable in all regions (and the list property will be absent).
     list: Array of Objects. Denotes the regions in which the offer is applicable. Properties: name, countryCode.
    voucherObject
    		This property will only be present if the offer is of type “voucher”.
     code: String. The voucher code, to be entered on the Advertiser’s checkout page.
     If there is no membership with the advertiser, this value will be null – the publisher should join the Advertiser programme in order to have visibility of the voucher code.
     exclusive: Boolean. Whether this voucher code is exclusive to your publisher account.
     attributable: Whether the use of this voucher code will automatically attribute the sale to your publisher account, regardless of tracking links used. 
    Was this article helpful?
    What's Next

    © 2024, AWIN Ltd. All rights reserved. Awin is part of Axel Springer Group. No part of this publication may be reproduced, translated, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without the prior permission of the copyright owner.