Skip to content

ParcelTrackingApi.md

Latest commit

 

History

History
133 lines (90 loc) · 5 KB

ParcelTrackingApi.md

File metadata and controls

133 lines (90 loc) · 5 KB

Toppy\Sendcloud\V3\ParcelTrackingApi

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

Method HTTP request Description
scPublicV3ShippingIntelligenceEngineGetGetParcelByTrackingNumber() GET /parcels/tracking/{tracking_number} Retrieve tracking information for a parcel
scPublicV3ShippingIntelligenceEnginePostRegisterParcelForTracking() POST /parcels/tracking Create a tracking-only parcel

scPublicV3ShippingIntelligenceEngineGetGetParcelByTrackingNumber()

scPublicV3ShippingIntelligenceEngineGetGetParcelByTrackingNumber($trackingNumber): \Toppy\Sendcloud\V3\Model\ParcelTrackingParcelTrackingResponse

Retrieve tracking information for a parcel

Get information about a parcel, including its current status and recent tracking events, using its tracking number

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\ParcelTrackingApi(
    // 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
);
$trackingNumber = 'trackingNumber_example'; // string | Parcel tracking number

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

Parameters

Name Type Description Notes
trackingNumber string Parcel tracking number

Return type

\Toppy\Sendcloud\V3\Model\ParcelTrackingParcelTrackingResponse

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]

scPublicV3ShippingIntelligenceEnginePostRegisterParcelForTracking()

scPublicV3ShippingIntelligenceEnginePostRegisterParcelForTracking($parcelTrackingParcelTrackingCreateRequest): \Toppy\Sendcloud\V3\Model\ParcelTrackingParcelTrackingCreateResponse

Create a tracking-only parcel

Register a parcel in the Sendcloud system for Tracking-Only, based on the provided details. It requires a valid tracking number and parcel information.

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\ParcelTrackingApi(
    // 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
);
$parcelTrackingParcelTrackingCreateRequest = new \Toppy\Sendcloud\V3\Model\ParcelTrackingParcelTrackingCreateRequest(); // \Toppy\Sendcloud\V3\Model\ParcelTrackingParcelTrackingCreateRequest

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

Parameters

Name Type Description Notes
parcelTrackingParcelTrackingCreateRequest \Toppy\Sendcloud\V3\Model\ParcelTrackingParcelTrackingCreateRequest

Return type

\Toppy\Sendcloud\V3\Model\ParcelTrackingParcelTrackingCreateResponse

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]