Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stasplov/jde-shipping

jde-shipping lib
https://github.com/stasplov/jde-shipping

api jde sdk shipment shipping-api

Last synced: 2 months ago
JSON representation

jde-shipping lib

Host: GitHub
URL: https://github.com/stasplov/jde-shipping
Owner: StasPlov
License: other
Created: 2024-09-26T00:31:41.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-10-16T02:41:44.000Z (3 months ago)
Last Synced: 2024-10-17T15:56:54.700Z (3 months ago)
Topics: api, jde, sdk, shipment, shipping-api
Language: PHP
Homepage: https://packagist.org/packages/stas-plov/jde-shipping
Size: 158 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

README

        # jde shipping API integration SDK

[![Latest Stable Version](http://poser.pugx.org/stas-plov/jde-shipping/v)](https://packagist.org/packages/stas-plov/jde-shipping)

[![Total Downloads](http://poser.pugx.org/stas-plov/jde-shipping/downloads)](https://packagist.org/packages/stas-plov/jde-shipping)

[![Latest Unstable Version](http://poser.pugx.org/stas-plov/jde-shipping/v/unstable)](https://packagist.org/packages/stas-plov/jde-shipping)

[![License](http://poser.pugx.org/stas-plov/jde-shipping/license)](https://packagist.org/packages/stas-plov/jde-shipping)

[![PHP Version Require](http://poser.pugx.org/stas-plov/jde-shipping/require/php)](https://packagist.org/packages/stas-plov/jde-shipping)

Features:

- [x] Cost Calculation

  - [x] Delivery cost calculation by addresses

  - [x] Delivery cost calculation

  - [x] SMART delivery cost calculation (by city names)

- [x] Requests

  - [x] New delivery request

  - [x] List of requests

- [ ] Shipments

  - [x] Receiving new shipment statuses

  - [x] Shipment delivery status by waybill number

  - [ ] Simplified shipment delivery status by waybill number

  - [x] Setting a delivery restriction on a shipment

- [ ] Services

  - [x] Receiving a list of service codes

  - [ ] Receiving information on shipment services

  - [ ] Receiving a package of documents

  - [ ] Receiving payment data for services

- [x] Geography

  - [x] Searching for terminals by KLADR

  - [x] Searching for cities by types

  - [x] Searching by terminal type

  - [x] Branch working hours

- [x] Documents

  - [x] Receiving documents

  - [x] Receiving a list of document codes

## Installation

```bash

composer require StasPlov/jde-shipping

```

# How to use

```php

$jdeShipping = new JdeShipping();

$jdeShipping->setUser('1234');

$jdeShipping->setToken('1234');

$geo = new GeoSearchRequest();

$geo ->setMode(1);

$result = $jdeShipping->getGeoSearch($geo);

```

## Cost Calculation

### Delivery cost calculation by addresses

```php

$shipmentCalc = (new ShipmentCostCalcByAddressRequest())

	->setAddrFrom('владивосток')

	->setAddrTo('москва')

	->setType(1)

	->setWeight(2.167)

	->setWidth(0.121)

	->setHeight(0.121)

	->setLength(2.135)

	->setQuantity(1)

	->setPickup(1)

	->setDelivery(1)

	->setDeclared(3670)

	->setOversizeWeight(1)

	->setOversizeVolume(1)

	->setObrVolume(0.031);

$result = $this->jdeShipping->getShipmentCostCalcByAddress($shipmentCalc);

if($result->isOk()) {

	$cost = $result->getPrice();

}

```

### Delivery cost calculation

```php

$shipmentCalc = (new ShipmentCostCalcRequest())

	->setFrom('1010005858')

	->setTo('1125904247254472')

	->setType(1)

	->setWeight(216)

	->setVolume(0.41);

$result = $this->jdeShipping->getShipmentCostCalcByAddress($shipmentCalc);

if($result->isOk()) {

	$cost = $result->getPrice();

}

```

### SMART delivery cost calculation (by city names)

```php

$shipmentCalc = (new ShipmentCostCalcRequest())

	->setFrom('Москва')

	->setTo('Владивосток')

	->setType(1)

	->setWeight(216)

	->setVolume(0.41)

	->setSmart(true);

	

$result = $this->jdeShipping->getShipmentCostCalcByAddress($shipmentCalc);

if($result->isOk()) {

	$cost = $result->getPrice();

}

```

## Order Requests

### New delivery request

```php

$order = (new OrderCreateRequest())

	->setFrom("1125899906842653")

	->setTo("1125899906842629")

	->setVolume(1)

	->setWeight(1)

	->setPositions(2)

	->setGruzdesc("Бытовая техника и электроника")

	->setPayer(JdeShipping::PAYER_SENDER)

	->setSender(

		(new PersonSender)

			->setAddr("Санкт-Петербург, Невский 30-2-12")

			->setTitle("ООО Отправитель")

			->setPhone("+79110000000")

	)

	->setReceiver(

		(new PersonReceiver)

			->setAddr("г. Москва, ул. 2-й Лучевой просек, д. 5В")

			->setTitle("ООО Получатель")

			->setPhone("+79110000000")

	);

$result = $this->jdeShipping->sendOrderCreate($geoKladr);

$orderNumber = $result->getOrderNumber();

```

### List of requests

```php

$geoKladr = new OrderListRequest();

$response = $this->jdeShipping->getOrderList($geoKladr);

if(!empty($result)) {

	$id = $result[0]->getId();

	$cargoStatus = $result[0]->getInfo()->getCargostatus()

}

```

## Geography

### Searching for terminals by KLADR

```php

$geoKladr = (new GeoSearchByKladrRequest())

	->setKladrCode('5002700102400');

$result = $this->jdeShipping->getGeoSearchByKladr($geoKladr);

if(!empty($result)) {

	$city = $result[0]->getCity();

	$address = $result[0]->getAddr();

}

```