diglin/sylius-advanced-api

Add additional information required to make the OroCRM integration working. Can be used for other purposes

Maintainers

Details

github.com/diglin/sylius-advanced-api

Source

Issues

Installs: 7

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:sylius-plugin

1.0.2 2021-08-17 08:19 UTC

Requires

MIT 5cd5c78b1bca9810f79134280e05162330fb9e46

  • Sylvain Rayé <support.woop@diglin.com>

This package is auto-updated.

Last update: 2024-12-24 16:34:01 UTC

README

This Sylius Bundle is required to be used together with the OroCRM Integration, however you can use it for other purposes for your Sylius project.

This Sylius Bundle is more permissive regarding the data available through the API allowing for some cases to have a more performant behavior.

For example, by default, when getting channels through GET /channels, you don't get all the details you may need for the returned channels list. This bundle allows to get more data when getting this list.

If you still wish to restrict the retrieving of some data, please keep the followings entity properties available for OroCRM to make it works correctly:

Channel

  • id (integer)

  • code (string)

  • name (string)

  • enabled (boolean)

  • createdAt (datetime)

  • updatedAt (datetime)

Customer

  • id (integer)

  • email (string)

  • firstName (string)

  • lastName (string)

  • gender (string)

  • group (array)

  • phoneNumber (string)

  • subscribedToNewsletter boolean

  • createdAt (datetime)

  • updatedAt (datetime)

Order

  • id (integer)

  • items (array)

  • itemsTotal (integer)

  • customer (array)

  • payments (array)

  • shipments (array)

  • adjustments (array)

  • adjustmentsTotal (integer)

  • total (integer)

  • shippingAddress (array)

  • billingAddress (array)

  • currencyCode (string)

  • number (string)

  • state (string)

  • checkoutCompletedAt (datetime)

  • createdAt (datetime)

  • updatedAt (datetime)

  • channel (array)

  • localeCode (string)

  • checkoutState (string)

OrderItem

  • id (integer)

  • quantity (integer)

  • unitPrice (integer)

  • total (integer)

  • unitsTotal (integer)

  • adjusmtents (array)

  • adjusmtentsTotal (integer)

  • variant (array)

  • createdAt (datetime)

  • updatedAt (datetime)

  • productName (string)

Payments

  • id (integer)
  • amount (integer)
  • state (string)
  • method (array)
  • currencyCode (string)

Shipments

  • id (integer)
  • state (string)
  • method (array)

Adjustment

  • id (integer)
  • type (string)
  • label (string)
  • amount (string)
  • tracking (string)

Address

  • id (integer)
  • firstName (string)
  • lastName (string)
  • phoneNumber (string)
  • countryCode (string)
  • street (string)
  • city (string)
  • postcode (string)

Installation

composer require diglin/sylius-advanced-api:^1.0

Configuration

Add the following into the config/packages/_sylius.yml

imports:
    ...
    - { resource: "@DiglinSyliusAdvancedApiPlugin/Resources/config/app/config.yml" }

Then clear the sylius cache with the command: php bin/console -e prod cache:clear

Knows issues

  • If you customized yourself the API and mainly the core API of Sylius, you may have a conflict

License

See LICENSE.txt

Author