REST Resource: freelistingsprogram

    • FreeListingsProgramStatus resource provides the status and review eligibility of the free listing program for a given account.

    • Program status is determined by globalState , which indicates overall program state based on offer uploads and regional eligibility.

    • regionStatuses provides a breakdown of program status per region, including eligibility, review issues, onboarding requirements and review ineligibility reasons.

    • If a region is ineligible for review, reviewIneligibilityReason and reviewIneligibilityReasonDetails offer further insight, sometimes with a cooldown period.

    • Two methods, get and requestreview , allow retrieval of program status and initiation of a review request, respectively.

    Resource: FreeListingsProgramStatus

    Response message for freelistingsprogram.get.

    JSON representation 
     { 
 "globalState" 
 : 
 enum (  ProgramState 
 
) 
 , 
 "regionStatuses" 
 : 
 [ 
 { 
 object (  RegionStatus 
 
) 
 } 
 ] 
 }
    Fields
    globalState

    enum ( ProgramState )

    State of the program. ENABLED if there are offers for at least one region.
    regionStatuses[]

    object ( RegionStatus )

    Status of the program in each region. Regions with the same status and review eligibility are grouped together in regionCodes .

    ProgramState

    Different states of the program for the account.

    Enums
    PROGRAM_STATE_UNSPECIFIED State is unknown.
    NOT_ENABLED Program is not enabled for any country.
    NO_OFFERS_UPLOADED No products have been uploaded for any region. Upload products to Merchant Center.
    ENABLED Program is enabled and offers are uploaded for at least one country.

    RegionStatus

    Status of program and region.

    JSON representation 
     { 
 "regionCodes" 
 : 
 [ 
 string 
 ] 
 , 
 "eligibilityStatus" 
 : 
 enum (  State 
 
) 
 , 
 "reviewIssues" 
 : 
 [ 
 string 
 ] 
 , 
 "onboardingIssues" 
 : 
 [ 
 string 
 ] 
 , 
 "disapprovalDate" 
 : 
 string 
 , 
 "reviewEligibilityStatus" 
 : 
 enum (  ReviewEligibility 
 
) 
 , 
 "reviewIneligibilityReason" 
 : 
 enum (  ReviewIneligibilityReason 
 
) 
 , 
 "reviewIneligibilityReasonDescription" 
 : 
 string 
 , 
 "reviewIneligibilityReasonDetails" 
 : 
 { 
 object (  ReviewIneligibilityReasonDetails 
 
) 
 } 
 }
    Fields
    regionCodes[]

    string

    The two-letter ISO 3166-1 alpha-2 codes for all the regions with the same eligibilityStatus and reviewEligibility .
    eligibilityStatus

    enum ( State )

    Eligibility status of the standard free listing program.
    reviewIssues[]

    string

    Issues evaluated in the review process. Fix all issues before requesting a review.
    onboardingIssues[]

    string

    Issues that must be fixed to be eligible for review.
    disapprovalDate

    string

    Date by which eligibilityStatus will go from WARNING to DISAPPROVED . Only visible when your eligibilityStatus is WARNING. In ISO 8601 format: YYYY-MM-DD .
    reviewEligibilityStatus

    enum ( ReviewEligibility )

    If a program is eligible for review in a specific region. Only visible if eligibilityStatus is DISAPPROVED .
    reviewIneligibilityReason

    enum ( ReviewIneligibilityReason )

    Review ineligibility reason if account is not eligible for review.
    reviewIneligibilityReasonDescription

    string

    Reason a program in a specific region isn’t eligible for review. Only visible if reviewEligibilityStatus is INELIGIBLE .
    reviewIneligibilityReasonDetails

    object ( ReviewIneligibilityReasonDetails )

    Additional information for ineligibility. If reviewIneligibilityReason is IN_COOLDOWN_PERIOD , a timestamp for the end of the cooldown period is provided.

    ReviewIneligibilityReasonDetails

    Additional details for review ineligibility reasons.

    JSON representation 
     { 
 "cooldownTime" 
 : 
 string 
 }
    Fields
    cooldownTime

    string ( Timestamp format)

    This timestamp represents end of cooldown period for review ineligbility reason IN_COOLDOWN_PERIOD .

    Methods

    get

    		Retrieves the status and review eligibility for the free listing program.

    requestreview

    		Requests a review of free listings in a specific region.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: