FlxpointAPI Help CenterBeta

Acknowledge Listing Parents

patchhttps://api.flxpoint.com/listing/parents

Use this when you want to update listing data through the API.

🔑 X-API-TOKEN⏱ 2 req/sToken: Account · Source · Channel

This page explains the endpoint. To send a live test request, use the interactive tester in Stoplight or your own Postman / HTTP client.

If you are leveraging the `publish` flag on `GET /listing/parents`, this endpoint allows you to respond to those interactions.

If a listing has a `changeToListingStatus` pending and you respond WITHOUT an `error`, Flxpoint will assume the status change worked as intended.

Request

Bodyapplication/json
array[ListingParentAcknowledgement]
listingParentIdintegerrequired
externalListingIdstring
(Optional) Must be Unique (per channel)! If you are responding to a `publish` operation (meaning, this is a brand new listing you've never seen), you can optionally pass an `externalListingId` which you can use to associate listings when Creating Orders. If an `externalListingId` is NOT provided after a publish, we will use `sku` as the `externalListingId`.
errorstring
If this field is `null`, we will assume a successful interaction. If an interaction failed, please provide a reason by populating this field.
variantsarray[ListingParentAcknowledgementVariant]required
listingVariantIdintegerrequired
externalListingIdstring
(Optional) Must be Unique (per channel)! If you are responding to a `publish` operation (meaning, this is a brand new listing you've never seen), you can optionally pass an `externalListingId` which you can use to associate listings when Creating Orders. If an `externalListingId` is NOT provided after a publish, we will use `sku` as the `externalListingId`.
errorstring
If this field is `null`, we will assume a successful interaction. If an interaction failed, please provide a reason by populating this field.
imagesarray[ListingAcknowledgementImage]
idinteger
externalListingIdstring
(Optional) Must be Unique (per channel)! If you are responding to a `publish` or `overwrite` operation, you can optionally pass an `externalListingId` per image which you can use to associate your own ID to a specific image. If an `externalListingId` is NOT provided after publishing an image, the `externalListingId` will be left empty.
listingErrorstring
If this field is `null`, we will assume a successful interaction. If an interaction failed, please provide a reason by populating this field.
isLinkedToRegularProductboolean
Set it to `true` if it is a standard product (Having no variants)
imagesarray[ListingAcknowledgementImage]
idinteger
externalListingIdstring
(Optional) Must be Unique (per channel)! If you are responding to a `publish` or `overwrite` operation, you can optionally pass an `externalListingId` per image which you can use to associate your own ID to a specific image. If an `externalListingId` is NOT provided after publishing an image, the `externalListingId` will be left empty.
listingErrorstring
If this field is `null`, we will assume a successful interaction. If an interaction failed, please provide a reason by populating this field.

Example request

patch/listing/parents
curl -X PATCH "https://api.flxpoint.com/listing/parents" \
  -H "Accept: application/json" \
  -H "X-API-TOKEN: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
         {
           "listingParentId": 0,
           "externalListingId": "string",
           "error": "string",
           "variants": [
             {
               "listingVariantId": 0,
               "externalListingId": "string",
               "error": "string",
               "images": [
                 null
               ],
               "isLinkedToRegularProduct": true
             }
           ],
           "images": [
             {
               "id": 0,
               "externalListingId": "string",
               "listingError": "string"
             }
           ]
         }
       ]'
Example body · application/json
[
  {
    "listingParentId": 0,
    "externalListingId": "string",
    "error": "string",
    "variants": [
      {
        "listingVariantId": 0,
        "externalListingId": "string",
        "error": "string",
        "images": [
          null
        ],
        "isLinkedToRegularProduct": true
      }
    ],
    "images": [
      {
        "id": 0,
        "externalListingId": "string",
        "listingError": "string"
      }
    ]
  }
]

Responses

200OK

No schema documented for this status.

400Bad Requestapplication/json
errorstring
A generalized error message, may or may not be fit for human consumption.
dataobject
Data points that could be useful in debugging the error.
No properties documented.
Example response
{
  "error": "string",
  "data": {}
}
401Unauthorized

No schema documented for this status.

OpenAPI fragment
{
  "patch": {
    "summary": "Acknowledge Listing Parents",
    "description": "If you are leveraging the `publish` flag on `GET /listing/parents`, this endpoint allows you to respond to those interactions. \n\nIf a listing has a `changeToListingStatus` pending and you respond WITHOUT an `error`, Flxpoint will assume the status change worked as intended.",
    "parameters": [],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "$ref": "#/components/schemas/ListingParentAcknowledgement"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "OK"
      },
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GenericApiError"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized"
      }
    }
  }
}
Ready to run it? Send the curl from your terminal or Postman, or use the interactive tester in Stoplight.Open in Stoplight