Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 8.88 KB

StorefrontEndpointsApi.md

File metadata and controls

271 lines (188 loc) · 8.88 KB
Raw

OpenAPI\Client\StorefrontEndpointsApi

All URIs are relative to https://}.

Method HTTP request Description
postPauseStoreEventResult() POST /v1/storefront/pause Notify the result of a pause request event
postStoreAvailabilityChange() POST /v1/storefront/availability Notify about store availability change
postStoreHoursConfigurationChange() POST /v1/storefront/hours Notify about store hours configuration change
postUnpauseStoreEventResult() POST /v1/storefront/unpause Notify the result of an unpause request event

postPauseStoreEventResult()

postPauseStoreEventResult($x_application_id, $x_store_id, $x_event_id, $pause_store_event_result)

Notify the result of a pause request event

RATE LIMIT: 8 per minute

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2.0
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\StorefrontEndpointsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_application_id = 'x_application_id_example'; // string
$x_store_id = 'x_store_id_example'; // string
$x_event_id = cf0ce51b-d74e-40d3-b177-1925ab4edc0c; // string
$pause_store_event_result = new \OpenAPI\Client\Model\PauseStoreEventResult(); // \OpenAPI\Client\Model\PauseStoreEventResult

try {
    $apiInstance->postPauseStoreEventResult($x_application_id, $x_store_id, $x_event_id, $pause_store_event_result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontEndpointsApi->postPauseStoreEventResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
x_application_id string
x_store_id string
x_event_id string
pause_store_event_result \OpenAPI\Client\Model\PauseStoreEventResult

Return type

void (empty response body)

Authorization

OAuth2.0

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postStoreAvailabilityChange()

postStoreAvailabilityChange($x_application_id, $x_store_id, $store_availability_event_result, $x_event_id)

Notify about store availability change

RATE LIMIT: 16 per minute

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2.0
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\StorefrontEndpointsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_application_id = 'x_application_id_example'; // string
$x_store_id = 'x_store_id_example'; // string
$store_availability_event_result = new \OpenAPI\Client\Model\StoreAvailabilityEventResult(); // \OpenAPI\Client\Model\StoreAvailabilityEventResult
$x_event_id = cf0ce51b-d74e-40d3-b177-1925ab4edc0c; // string

try {
    $apiInstance->postStoreAvailabilityChange($x_application_id, $x_store_id, $store_availability_event_result, $x_event_id);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontEndpointsApi->postStoreAvailabilityChange: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
x_application_id string
x_store_id string
store_availability_event_result \OpenAPI\Client\Model\StoreAvailabilityEventResult
x_event_id string [optional]

Return type

void (empty response body)

Authorization

OAuth2.0

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postStoreHoursConfigurationChange()

postStoreHoursConfigurationChange($x_application_id, $x_store_id, $store_hours_configuration_event_result, $x_event_id)

Notify about store hours configuration change

RATE LIMIT: 16 per minute

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2.0
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\StorefrontEndpointsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_application_id = 'x_application_id_example'; // string
$x_store_id = 'x_store_id_example'; // string
$store_hours_configuration_event_result = new \OpenAPI\Client\Model\StoreHoursConfigurationEventResult(); // \OpenAPI\Client\Model\StoreHoursConfigurationEventResult
$x_event_id = cf0ce51b-d74e-40d3-b177-1925ab4edc0c; // string

try {
    $apiInstance->postStoreHoursConfigurationChange($x_application_id, $x_store_id, $store_hours_configuration_event_result, $x_event_id);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontEndpointsApi->postStoreHoursConfigurationChange: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
x_application_id string
x_store_id string
store_hours_configuration_event_result \OpenAPI\Client\Model\StoreHoursConfigurationEventResult
x_event_id string [optional]

Return type

void (empty response body)

Authorization

OAuth2.0

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postUnpauseStoreEventResult()

postUnpauseStoreEventResult($x_application_id, $x_store_id, $x_event_id, $unpause_store_event_result)

Notify the result of an unpause request event

RATE LIMIT: 8 per minute

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth2.0
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\StorefrontEndpointsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_application_id = 'x_application_id_example'; // string
$x_store_id = 'x_store_id_example'; // string
$x_event_id = cf0ce51b-d74e-40d3-b177-1925ab4edc0c; // string
$unpause_store_event_result = new \OpenAPI\Client\Model\UnpauseStoreEventResult(); // \OpenAPI\Client\Model\UnpauseStoreEventResult

try {
    $apiInstance->postUnpauseStoreEventResult($x_application_id, $x_store_id, $x_event_id, $unpause_store_event_result);
} catch (Exception $e) {
    echo 'Exception when calling StorefrontEndpointsApi->postUnpauseStoreEventResult: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
x_application_id string
x_store_id string
x_event_id string
unpause_store_event_result \OpenAPI\Client\Model\UnpauseStoreEventResult

Return type

void (empty response body)

Authorization

OAuth2.0

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]