README

简介

此包提供了与vShip API交互的基本接口。

文档

安装

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

composer require vshipdk/php-sdk

基本用法

初始化vShip客户端

    $client = new \Vship\Client(
        apiKey: { Your API key }
    );

通过客户端发送请求

    $client->getCountries();

    $client->getCarrier('car_2IGXIoELZX4Bga45tOxo52sbpJY');

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

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

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

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

API参考

vShip客户端

承运商

获取所有承运商

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

获取单个承运商

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

创建承运商

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

更新承运商

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

删除承运商

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

承运商账户

获取所有承运商账户

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

获取单个承运商账户

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

创建承运商账户

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

更新承运商账户

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

删除承运商账户

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

获取承运商账户字段

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

国家

获取所有国家

    $client->getCountries(): Country

标签

获取或打印运输标签

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

组织对象

获取所有组织对象

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

获取单个组织对象

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

创建组织对象

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

更新组织对象

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

删除组织对象

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

组织

获取所有组织

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

获取单个组织

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

创建组织

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

更新组织

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

删除组织

    $client->deleteOrganisation($organisationId): Organisation

运输

获取所有运输

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

创建运输

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

更新运输

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

更新运输状态

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

存档运输

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

用户

获取所有用户

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

获取单个用户

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

合并发票

创建合并发票

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