Glue API: Retrieve product offer service point availability

Edit on GitHub

This endpoint lets you product offer availability per service points.

Installation

Install the Product Offer Service Points Availability feature

Retrieve service points


POST /product-offer-service-point-availabilities


Request

Request sample: POST https://glue.mysprykershop.com/product-offer-service-point-availabilities

{
    "data": {
        "type": "product-offer-service-point-availabilities",
        "attributes": {
            "servicePointUuids": [
                "262feb9d-33a7-5c55-9b04-45b1fd22067e",
                "7e3b03e0-c53c-5298-9ece-968f4628b4f8"
            ],
            "serviceTypeUuid": "2370ad95-4e9f-5ac3-913e-300c5805b181",
            "productOfferServicePointAvailabilityRequestItems": [
                {
                    "productConcreteSku": "093_24495843",
                    "productOfferReference": "offer419",
                    "quantity": 1,
                    "merchantReference": "MER000001"
                },
                {
                    "productConcreteSku": "091_25873091",
                    "productOfferReference": "offer420",
                    "quantity": 1,
                    "merchantReference": "MER000001"
                }
            ],
            "shipmentTypeUuid": "174d9dc0-55ae-5c4b-a2f2-a419027029ef"
        }
    }
}
ATTRIBUTE TYPE REQUIRED DESCRIPTION
servicePointUuids Object The list of service points to retrieve the availability from. To get them, retrieve service points
serviceTypeUuid String The service type to retrieve the product offer availability for. To get it, retrieve service types
productConcreteSku String The concrete product to retrieve the availability of. To get it, retrieve concrete products
productOfferReference String The product offer to retrieve the availability of. To get it, retrieve product offers
quantity String The quantity to retrieve the availability for.
merchantReference String The merchant to retrieve the product offer availability of. To get it, retrieve product offers](/docs/pbc/all/offer-management/202404.0/marketplace/glue-api-retrieve-product-offers.html)
shipmentTypeUuid String The shipment type to check the product offer availability for. To get it, retrieve shipment types

Response

{
    "data": {
        "type": "product-offer-service-point-availabilities",
        "id": null,
        "attributes": {
            "productOfferServicePointAvailabilities": [
                {
                    "servicePointUuid": "262feb9d-33a7-5c55-9b04-45b1fd22067e",
                    "productOfferServicePointAvailabilityResponseItems": [
                        {
                            "productOfferReference": "offer419",
                            "isNeverOutOfStock": false,
                            "isAvailable": false,
                            "availableQuantity": 0,
                            "productConcreteSku": "093_24495843",
                            "identifier": "0"
                        },
                        {
                            "productOfferReference": "offer420",
                            "isNeverOutOfStock": false,
                            "isAvailable": false,
                            "availableQuantity": 0,
                            "productConcreteSku": "091_25873091",
                            "identifier": "1"
                        }
                    ]
                },
                {
                    "servicePointUuid": "7e3b03e0-c53c-5298-9ece-968f4628b4f8",
                    "productOfferServicePointAvailabilityResponseItems": [
                        {
                            "productOfferReference": "offer419",
                            "isNeverOutOfStock": false,
                            "isAvailable": false,
                            "availableQuantity": 0,
                            "productConcreteSku": "093_24495843",
                            "identifier": "0"
                        },
                        {
                            "productOfferReference": "offer420",
                            "isNeverOutOfStock": false,
                            "isAvailable": false,
                            "availableQuantity": 0,
                            "productConcreteSku": "091_25873091",
                            "identifier": "1"
                        }
                    ]
                }
            ]
        },
        "links": {
            "self": "https://glue.mysprykershop.com/product-offer-service-point-availabilities"
        }
    }
}
RESOURCE ATTRIBUTE TYPE DESCRIPTION
product-offer-service-point-availabilities servicePointUuid String Define the service point for which the availability is provided.
product-offer-service-point-availabilities productOfferServicePointAvailabilityResponseItems Object List of product offers returned for a servicePointUuid.
product-offer-service-point-availabilities productOfferReference String Identifier of the product offer for which availability is returned.
product-offer-service-point-availabilities isNeverOutOfStock Boolean Defines if the product offer can run out of stock.
product-offer-service-point-availabilities isAvailable String Defines if the product offer is available for ordering.
product-offer-service-point-availabilities availableQuantity String Defines the quantity of the product offer available for ordering.
product-offer-service-point-availabilities productConcreteSku String
product-offer-service-point-availabilities identifier String

Possible errors

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.