Listings endpoint
ListingSearchPayload
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
ListingPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
ListingBulkUpsertPayload
Result of the bulk upsert operation
ListingBulkUpsertResponse
Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this
The requested entity was not found
A version conflict occurred.
ID of facility you want to get listing. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
tenantArticleId of listing you want to get
Provide the localized names and descriptions for the listing. If not provided the default locale is used., for example de_DE.
Listing is found & you were allowed to access it. The result is in the body.
Listing
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Listings not found
ID of facility you want to delete all listings of. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
Facility listings were found and successfully deleted
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
No content
ID of facility you want to get listing for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
all entities after given Id
number of facilities to show
25Array of tenantArticleIds
limit results to this scannableCode
Facility was found & you were allowed to access it. The results are in the body.
StrippedListings
Total number of found entities for this query
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility not found
ID of facility you want to put listings for. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
ListingsForReplacement
Facility listing was found & you were allowed to access it. The result is in the body.
ListingBulkOperationResult
BulkOperationResultStatus
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
ID of facility you want to patch a listing of. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
tenant ID of the articles listing you want to patch
ListingPatchActions
The version of the document to be used in optimistic locking mechanisms.
42Facility listing was found and successfully patched
Listing
Invalid input. See response for details
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
Listing version conflict
ID of facility you want to get the partial stocks. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
ID of listing you want to get partial stocks
Facility and listing were found & you are allowed to access it. The result is in the body.
PartialStock
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility or Listing not found
ID of facility you want to delete a listing of. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
tenant ID of the articles listing you want to delete
Facility listing was found and successfully deleted
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
No content
ID of facility you want to get listing. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
ID of listing you want to get partial stocks
PartialStocksForReplacement
The version of the listing where we want to put the partialStocks, to be used in optimistic locking mechanisms.
42Facility listing was found & you were allowed to update it.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
No content
ID of facility you want to patch the partial stocks. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
ID of listing you want to get partial stocks
PartialStockPatchActions
The version of the listing where we want to patch the partialStocks, to be used in optimistic locking mechanisms.
42Facility listing was found & you were allowed to update it.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
No content
ID of facility from whom you want to delete the partial stock. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).
ID of listing you want to get partial stocks
Facility listing was found & you were allowed to delete the partial stock.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Facility listing not found
No content
Last updated