Git Product home page Git Product logo

sendcloud-shipping-api's Introduction

A working API for a shitty API

A simple API that supports almost all calls and which is mapped to objects accordingly.

Initialize the client as follows and work with the api

$client = new \HarmSmits\SendCloudClient\Client(
    "...",
    "..."
);

Going over all parcels is really easy:

$cursor = null;
while (($result = $client->getParcels($cursor))) {
    $cursor = $result->getNext();
    foreach ($result->getParcels() as $parcel) {
        ...
    }
}

Statuses work likewise:

foreach ($client->getParcelStatuses() as $parcelStatus) {
    ...
}

Same for brands:

$cursor = null;
while (($result = $client->getBrands($cursor))) {
    $cursor = $result->getNext();
    foreach ($result->getBrands() as $brand) {
        ...
    }
}

Everything can be done asynchronously as well

$promise = $client->asyncGetParcelStatuses();
...
$result = $promise->wait();

The following methods can be used directly from the client, suffix with Async if you want to get a promise.

  • getParcels
  • getParcel
  • createParcel
  • createParcels
  • updateParcel
  • cancelOrDeleteParcel
  • getParcelReturnPortalUrl
  • getParcelDocuments
  • getParcelStatuses
  • getReturns
  • getReturn
  • getBrands
  • getBrand
  • getShippingMethods
  • getShippingMethod
  • getPdfLabel
  • getBulkPdfLabel
  • getUser
  • getInvoices
  • getInvoice
  • getSenderAddresses
  • getSenderAddress
  • getIntegrations

sendcloud-shipping-api's People

Contributors

harm-smits avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.