shippii-tech/php-sdk

shippii.com SDK

维护者

详情

github.com/Shippii-Tech/php-sdk

源代码

问题

安装: 16

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 3

1.0.0 2023-01-19 12:24 UTC

Requires

Requires (Dev)

MIT df6200b5cf93b9d37f156f02823a92b2d32dfca8

  • Stoyan Todorov <s.todorov.woop@vconnect.dk>

This package is auto-updated.

Last update: 2024-09-19 15:58:11 UTC

README

Total Downloads Latest Stable Version License

简介

此包提供了与 Shippii API v4 交互的表达式化接口。

官方文档

安装

要在项目中安装 SDK，您需要通过 composer 引入此包

composer require shippii-tech/php-sdk

升级

当升级到 SHIPPII API v4 PHP SDK 的新主要版本时，仔细阅读升级指南非常重要。

基本用法

初始化 Shippii 客户端

    $shippii = new \Shippii\Shippii(
        apiKey: { Your API key }
    );

通过客户端发送请求

    $shippii->getCountries();

    $shippii->getCarrier('car_2IGXIoELZX4Bga45tOxo52sbpJY');

通过客户端发送带查询参数的请求

    $shippii->getCarriers([
        'filter[name]' => 'Carrier name',
    ]);

通过客户端发送带有正文的请求以创建 API 资源

    $response = $shippii->createOrganisation([
        'name' => 'test 5222ee5511232ff31rr33',
        'vat_number' => '123423rr4 ',
        'company_number' => 'bhifgrvbhief',
        'vat_registered' => false,
        'currency' => 'EUR',
        'timezone' => 'Europe/Copenhagen',
        'settings' => [],
    ]);

API 参考


Shippii 客户端

承运人

获取所有承运人

    $shippii->getCarriers(array queryParameters = []): Carrier[]

获取单个承运人

    $shippii->getCarrier(string $carrierId): Carrier

创建承运人

    $shippii->createCarrier(array $payload): Carrier

更新承运人

    $shippii->updateCarrier(string $carrierId, array $payload): Carrier

删除承运人

    $shippii->deleteCarrier(string $carrierId): Carrier

承运人账户

获取所有承运人账户

    $shippii->getCarrierAccounts(array $queryParameters = []): CarrierAccount[]

获取单个承运人账户

    $shippii->getCarrierAccount(string $carrierAccountId): CarrierAccount

创建承运人账户

    $shippii->createCarrierAccount(array $payload): CarrierAccount

更新承运人账户

    $shippii->updateCarrierAccount(string $carrierAccountId, array $payload): CarrierAccount

删除承运人账户

    $shippii->deleteCarrierAccount(string $carrierAccountId): CarrierAccount

获取承运人账户字段

    $shippii->getCarrierAccountFields(string $carrierCode): CarrierAccountFields

国家

获取所有国家

    $shippii->getCountries(): Country

标签

获取或打印运输标签

    $shippii->fetchPrintShipmentLabel(string $shipmentId, array $parameters): Label

组织对象

获取所有组织对象

    $shippii->getOrganisationObjects(array $queryParameters = []): OrganisationObject[]

获取单个组织对象

    $shippii->getOrganisationObject(string $organisationObjectId): OrganisationObject

创建组织对象

    $shippii->createOrganisationObject(array $payload): OrganisationObject

更新组织对象

    $shippii->updateOrganisationObject(string $organisationObjectId, array $payload): OrganisationObject

删除组织对象

    $shippii->deleteOrganisationObject(string $organisationObjectId): OrganisationObject

组织

获取所有组织

    $shippii->getOrganisations(array $queryParameters = []): Organisation[]

获取单个组织

    $shippii->getOrganisation(string $organisationId): Organisation

创建组织

    $shippii->createOrganisation(array $payload): Organisation

更新组织

    $shippii->updateOrganisation(string $organisationId, array $payload): Organisation

删除组织

    $shippii->deleteOrganisation($organisationId): Organisation

运输

获取所有运输

    $shippii->getShipments(array $queryParameters = []): Shipment[]

创建运输

    $shippii->createShipment(array $payload): Shipment

更新运输

    $shippii->updateShipment(string $shipmentId, array $payload): Shipment

更新运输状态

    $shippii->updateShipmentState(string shipmentId, string $shipmentState): Shipment

存档运输

    $shippii->archiveShipment(string $shipmentId): Shipment

用户

获取所有用户

    $shippii->getUsers(array $queryParameters = []): User[]

获取单个用户

    $shippii->getUser(string $userId): User

合并发票

创建合并发票

    $shippii->createConsolidateInvoice(array $payload): Invoice

模型属性


承运人

    public string|null $id = null;
    public Owner|null $owner = null;
    public string|null $name = null;
    public CarrierAccount|null $account = null;
    public string|null $code = null;
    public CarrierSettings|null $settings = null;
    public int|null $status = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    public string|null $carrier_identification = null;

承运人账户

    public string|null $id = null;
    public string|null $name = null;
    /** @var CarrierAccountFields[]|null */
    public array|null $fields = null;
    public string|null $carrier_code = null;
    public string|null $status = null;
    public string|null $purpose = null;
    /** @var Carrier[]|null */
    public array|null $carriers = null;
    public string|null $expires_at = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;

国家

    public string|null $name = null;
    public string|null $official_state_name = null;
    public string|null $alpha_2_code = null;
    public string|null $alpha_3_code = null;
    public string|null $numeric_code = null;

标签

    public string|null $id = null;
    public string|null $shipmentId = null;
    public string|null $format = null;
    public string|null $metadata = null;
    public Owner|null $owner = null;
    public string|null $url = null;
    public string|null $createdAt = null;
    public string|null $type = null;
    public string|null $temporary_url = null;

组织

    public string|null $id = null;
    public Owner|null $owner = null;
    public string|null $name = null;
    public string|null $vat_number = null;
    public string|null $company_number = null;
    public bool|null $vat_registered = null;
    public string|null $currency = null;
    public string|null $timezone = null;
    public OrganisationSettings|null $settings = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    /** @var Address[]|null */
    public array|null $addresses = null;

组织对象

    public string|null $id = null;
    public string|null $name = null;
    public Organisation|null $organisation = null;
    public string|null $currency = null;
    public string|null $timezone = null;
    public OrganisationObjectSettings|null $settings = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    /** @var Address[]|null */
    public array|null $addresses = null;

运输

    public string|null $id = null;
    public string|null $rate_id = null;
    public int|null $type = null;
    public string|null $state = null;
    /** @var ShipmentMetadata[]|null  */
    public array|null $metadata = null;
    /** @var Tag[]|null  */
    public array|null $tags = null;
    public string|null $group = null;
    public string|null $creator_id = null;
    public string|null $creator_type = null;
    public string|null $sendable_id = null;
    public string|null $sendable_address_id = null;
    public string|null $receivable_id = null;
    public string|null $receivable_address_id = null;
    public string|null $sendable_reference = null;
    public string|null $system_reference = null;
    public Address|null $receivable_address = null;
    public User|null $receivable = null;
    public Address|null $sendable_address = null;
    public OrganisationObject|null $organisation_object = null;
    public string|null $carrier_identification = null;
    public Carrier|null $carrier = null;
    public User|null $creator = null;
    /** @var Line[]|null  */
    public array|null $items = null;
    /** @var ActivityLog[]|null  */
    public array|null $logs = null;
    public string|null $shipment_carrier_data = null;
    public string|null $created_at = null;
    public string|null $updated_at = null;
    public string|null $reference = null;
    public ShipmentSendable|null $sendable = null;
    public Label|null $label = null;
    /** @var Parcel[]|null */
    public array|null $parcels = null;

用户

    public string|null $id = null;
    public string|null $first_name = null;
    public string|null $last_name = null;
    public string|null $email = null;
    public string|null $mobile_e164 = null;
    public string|null $mobile_national = null;
    public string|null $mobile_raw = null;
    public string|null $role = null;
    public string|null $timezone = null;
    public string|null $locale = null;
    public string|null $created_at = null;
    public string|null $update_at = null;
    /** @var Organisation[]|null  */
    public array|null $organisations = null;

发票

    public string|null $invoice_url = null;