Skip to content

LabelsApi.md

Latest commit

 

History

History
133 lines (90 loc) · 4.47 KB

LabelsApi.md

File metadata and controls

133 lines (90 loc) · 4.47 KB

Toppy\Sendcloud\V2\LabelsApi

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

Method HTTP request Description
scPublicV2ScpGetLabelByParcelId() GET /labels/{parcel_id} Retrieve a label for a specific parcel
scPublicV2ScpPostLabelByParcelIds() POST /labels Bulk PDF label printing

scPublicV2ScpGetLabelByParcelId()

scPublicV2ScpGetLabelByParcelId($parcelId): \Toppy\Sendcloud\V2\Model\LabelSingleResponse

Retrieve a label for a specific parcel

You will receive URLs to download the labels in PDF format, for both normal and label printers. You can get the id of a parcel from the Create a parcel or parcels endpoint.

Example

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


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


$apiInstance = new Toppy\Sendcloud\V2\Api\LabelsApi(
    // 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
);
$parcelId = 1; // int | Unique parcel identifier

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

Parameters

Name Type Description Notes
parcelId int Unique parcel identifier

Return type

\Toppy\Sendcloud\V2\Model\LabelSingleResponse

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]

scPublicV2ScpPostLabelByParcelIds()

scPublicV2ScpPostLabelByParcelIds($scPublicV2ScpPostLabelByParcelIdsRequest): \Toppy\Sendcloud\V2\Model\LabelMultipleResponse

Bulk PDF label printing

Request multiple shipping labels for an array of parcels at the same time. You will receive URLs to download the labels in PDF format, for both normal and label printers.

Example

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


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


$apiInstance = new Toppy\Sendcloud\V2\Api\LabelsApi(
    // 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
);
$scPublicV2ScpPostLabelByParcelIdsRequest = new \Toppy\Sendcloud\V2\Model\ScPublicV2ScpPostLabelByParcelIdsRequest(); // \Toppy\Sendcloud\V2\Model\ScPublicV2ScpPostLabelByParcelIdsRequest

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

Parameters

Name Type Description Notes
scPublicV2ScpPostLabelByParcelIdsRequest \Toppy\Sendcloud\V2\Model\ScPublicV2ScpPostLabelByParcelIdsRequest

Return type

\Toppy\Sendcloud\V2\Model\LabelMultipleResponse

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]