fond-of-spryker/companies-company-addresses-rest-api

Company company addresses rest api

dev-master 2020-04-06 07:58 UTC

Requires

• php: >=7.1
• fond-of-spryker/companies-company-users-rest-api: dev-master
• fond-of-spryker/companies-rest-api: dev-master
• fond-of-spryker/country: dev-master
• spryker/company-business-unit: ^1.0.0 || ^2.0.0
• spryker/company-unit-address: ^1.0.0
• spryker/event: ^1.0.0 || ^2.0.0
• spryker/glue-application: ^1.0.0

Requires (Dev)

• codeception/codeception: ^2.4
• fond-of-codeception/spryker: dev-master as 1.0.0
• php-coveralls/php-coveralls: ^2.1
• phpro/grumphp: ^0.14
• sebastian/phpcpd: ^4.0
• spryker/code-sniffer: ^0.12

MIT

• József Geng

README

Installation

composer require fond-of-spryker/companies-company-addresses-rest-api

Glue API

Add/Update Company Unit Address

POST {{glue_uri}}//companies/{{company_uuid}}/companies-company-addresses/

Example

curl -X POST "http://glue.yourdomain.com/companies/{{company_uuid}}/companies-company-addresses/" \
     -H 'Content-Type: application/json' \
     -d $'{
          "data": {
            "type": "companies-company-addresses",
                "attributes": {
                  "name1": "{{name1}}",
                  "name2": "{{name2}}",
                  "address1": "{{address1}}",
                  "address2": "{{address2}}",
                  "city": "{{city}}",
                  "zipCode": "{{zipCode}}",
                  "country": "{{countryIso2Code}}",
                  "phone": "{{phone}}",
                  "fax": "{{fax}}",
                  "comment": "{{comment}}",
                  "isDefaultBilling": {{is default billing}}
                }
              }            
          }
     }'

PATCH {{glue_uri}}//companies/{{company_uuid}}/companies-company-addresses/{{company_unit_address_uuid}}

Example

curl -X POST "http://glue.yourdomain.com/companies/{{company_uuid}}/companies-company-addresses/{{company_unit_address_uuid}}" \
     -H 'Content-Type: application/json' \
     -d $'{
          "data": {
            "type": "companies-company-addresses",
                "attributes": {
                  "name1": "{{name1}}",
                  "name2": "{{name2}}",
                  "address1": "{{address1}}",
                  "address2": "{{address2}}",
                  "city": "{{city}}",
                  "zipCode": "{{zipCode}}",
                  "country": "{{countryIso2Code}}",
                  "phone": "{{phone}}",
                  "fax": "{{fax}}",
                  "comment": "{{comment}}",
                  "isDefaultBilling": {{is default billing}}
                }
              }            
          }
     }'