Skip to content

CarrierSupportContactsApi.md

Latest commit

 

History

History
257 lines (174 loc) · 9.09 KB

CarrierSupportContactsApi.md

File metadata and controls

257 lines (174 loc) · 9.09 KB

Toppy\Sendcloud\V3\CarrierSupportContactsApi

All URIs are relative to https://panel.sendcloud.sc/api/v3.

Method HTTP request Description
scPublicV3DsfDeleteCarrierSupportContacts() DELETE /dsf/carrier-support-contacts/{id} Delete a carrier support contact
scPublicV3DsfGetCarrierSupportContacts() GET /dsf/carrier-support-contacts Retrieve carrier support contacts
scPublicV3DsfPatchCarrierSupportContacts() PATCH /dsf/carrier-support-contacts/{id} Update a carrier support contact
scPublicV3DsfPostCarrierSupportContacts() POST /dsf/carrier-support-contacts Create carrier support contact

scPublicV3DsfDeleteCarrierSupportContacts()

scPublicV3DsfDeleteCarrierSupportContacts($id)

Delete a carrier support contact

A carrier support contact is required in order to create tickets for shipments sent under your own carrier contract so that we can forward the claim correctly. Ticket creation will fail if a carrier support contact is missing for a carrier you use with your own contract.

Example

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


// Configure HTTP basic authorization: HTTPBasicAuth
$config = Toppy\Sendcloud\V3\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Toppy\Sendcloud\V3\Api\CarrierSupportContactsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | Support contact id

try {
    $apiInstance->scPublicV3DsfDeleteCarrierSupportContacts($id);
} catch (Exception $e) {
    echo 'Exception when calling CarrierSupportContactsApi->scPublicV3DsfDeleteCarrierSupportContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int Support contact id

Return type

void (empty response body)

Authorization

HTTPBasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

scPublicV3DsfGetCarrierSupportContacts()

scPublicV3DsfGetCarrierSupportContacts(): \Toppy\Sendcloud\V3\Model\CarrierSupportContact

Retrieve carrier support contacts

A carrier support contact is required in order to create tickets for shipments sent under your own carrier contract so that we can forward the claim correctly. Ticket creation will fail if a carrier support contact is missing for a carrier you use with your own contract.

Example

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


// Configure HTTP basic authorization: HTTPBasicAuth
$config = Toppy\Sendcloud\V3\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Toppy\Sendcloud\V3\Api\CarrierSupportContactsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->scPublicV3DsfGetCarrierSupportContacts();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarrierSupportContactsApi->scPublicV3DsfGetCarrierSupportContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\Toppy\Sendcloud\V3\Model\CarrierSupportContact

Authorization

HTTPBasicAuth

HTTP request headers

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

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

scPublicV3DsfPatchCarrierSupportContacts()

scPublicV3DsfPatchCarrierSupportContacts($id, $patchSupportContactRequest): \Toppy\Sendcloud\V3\Model\CarrierSupportContact

Update a carrier support contact

A carrier support contact is required in order to create tickets for shipments sent under your own carrier contract so that we can forward the claim correctly. Ticket creation will fail if a carrier support contact is missing for a carrier you use with your own contract.

Example

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


// Configure HTTP basic authorization: HTTPBasicAuth
$config = Toppy\Sendcloud\V3\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Toppy\Sendcloud\V3\Api\CarrierSupportContactsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | Support contact id
$patchSupportContactRequest = new \Toppy\Sendcloud\V3\Model\PatchSupportContactRequest(); // \Toppy\Sendcloud\V3\Model\PatchSupportContactRequest

try {
    $result = $apiInstance->scPublicV3DsfPatchCarrierSupportContacts($id, $patchSupportContactRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarrierSupportContactsApi->scPublicV3DsfPatchCarrierSupportContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int Support contact id
patchSupportContactRequest \Toppy\Sendcloud\V3\Model\PatchSupportContactRequest

Return type

\Toppy\Sendcloud\V3\Model\CarrierSupportContact

Authorization

HTTPBasicAuth

HTTP request headers

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

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

scPublicV3DsfPostCarrierSupportContacts()

scPublicV3DsfPostCarrierSupportContacts($createSupportContactRequest): \Toppy\Sendcloud\V3\Model\CarrierSupportContact

Create carrier support contact

A carrier support contact is required in order to create tickets for shipments sent under your own carrier contract so that we can forward the claim correctly. Note that ticket creation will fail if a carrier support contact is missing for a carrier you use with your own contract.

Example

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


// Configure HTTP basic authorization: HTTPBasicAuth
$config = Toppy\Sendcloud\V3\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Toppy\Sendcloud\V3\Api\CarrierSupportContactsApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$createSupportContactRequest = new \Toppy\Sendcloud\V3\Model\CreateSupportContactRequest(); // \Toppy\Sendcloud\V3\Model\CreateSupportContactRequest

try {
    $result = $apiInstance->scPublicV3DsfPostCarrierSupportContacts($createSupportContactRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarrierSupportContactsApi->scPublicV3DsfPostCarrierSupportContacts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
createSupportContactRequest \Toppy\Sendcloud\V3\Model\CreateSupportContactRequest

Return type

\Toppy\Sendcloud\V3\Model\CarrierSupportContact

Authorization

HTTPBasicAuth

HTTP request headers

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

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