README

与Anymarket API集成的库

API官方文档 http://developers.anymarket.com.br/

通过composer安装

$ composer require yampi/anymarket-php-sdk

服务

此SDK支持以下服务

• 产品
• SKU
• 变体
• 变体值
• 库存
• 品牌
• 类别
• 订单
• 回调

配置

要使用此SDK，需要使用Anymarket账户的访问令牌（GumgaToken），并设置使用的环境：`sandbox`或`production`;

use Yampi\Anymarket\Anymarket;
use Yampi\Anymarket\Services\Environment;
use Yampi\Anymarket\Exceptions\AnymarketException;
use Yampi\Anymarket\Exceptions\AnymarketValidationException;

// Ambiente de sandbox
$anymarket = new Anymarket('SEU_TOKEN', Environment::sandbox());

// Ambiente de produção
$anymarket = new Anymarket('SEU_TOKEN', Environment::production());

产品

按页搜索所有产品，每页50条记录

$product = $anymarket->product()->get(0, 50);

搜索产品

$product = $anymarket->product()->find('ID_PRODUTO');

创建产品

$product = $anymarket->product()->create([
    'title '=>  'string',
    'description '=>  'string',
    'category '=> [
        'id '=> 0,
        'name '=>  'string',
        'path '=>  'string'
    ],
    'brand '=> [
        'id '=> 0,
        'name '=>  'string',
        'partnerId '=>  'string'
    ],
    'nbm '=> [
        'id '=>  'string'
    ],
    'origin '=> [
        'id '=> 0
    ],
    'model '=>  'string',
    'videoUrl '=>  'string',
    'gender '=>  'string',
    'warrantyTime '=> 0,
    'warrantyText '=>  'string',
    'height '=> 0,
    'width '=> 0,
    'weight '=> 0,
    'length '=> 0,
    'priceFactor '=> 0,
    'calculatedPrice '=> true,
    'definitionPriceScope '=>  'string',
    'characteristics '=> [
        [
            'index '=> 0,
            'name '=>  'string',
            'value '=>  'string'
        ]
    ],
    'images '=> [
        [
            'main '=> true,
            'url '=>  'string',
            'variation '=>  'string'
        ]
    ],
    'skus '=> [
        [
            'title '=>  'string ',
            'partnerId '=>  'string ',
            'ean '=>  'string ',
            'amount '=> 0,
            'price '=> 0,
            'additionalTime '=> 0,
            'variations '=> [
                    'variationName '=>  'VariationValue '
            ]
        ]
    ],
    'allowAutomaticSkuMarketplaceCreation '=> true
]);

更新产品

$product = $anymarket->product()->update('ID_PRODUTO', [
  'title' => 'string',
  'description' => 'string',
  'category' => [
    'id' => 0,
    'name' => 'string',
    'path' => 'string'
  ],
  'brand' => [
    'id' => 0,
    'name' => 'string',
    'partnerId' => 'string'
  ],
  'nbm' => [
    'id' => 'string'
  ],
  'origin' => [
    'id' => 0
  ],
  'model' => 'string',
  'videoUrl' => 'string',
  'gender' => 'string',
  'warrantyTime' => 0,
  'warrantyText' => 'string',
  'height' => 0,
  'width' => 0,
  'weight' => 0,
  'length' => 0,
  'priceFactor' => 0,
  'calculatedPrice' => true,
  'definitionPriceScope' => 'string',
  'characteristics' => [
    [
      'index' => 0,
      'name' => 'string',
      'value' => 'string'
    ]
  ],
  'images' => [
    [
      'main' => true,
      'url' => 'string',
      'variation' => 'string'
    ]
  ],
  'skus' => [
    [
      'title' => 'string',
      'partnerId' => 'string',
      'ean' => 'string',
      'amount' => 0,
      'price' => 0,
      'variations' => [
        'variationName' => 'VariationValue'
      ]
    ]
  ],
  'allowAutomaticSkuMarketplaceCreation' => true
]);

更新产品标题

$product = $anymarket->product()->updateTitle('ID_PRODUTO', 'TÍTULO');

SKU

需要使用setProduct方法来使用此功能

$anymarket->sku()->setProduct('ID_PRODUTO');

搜索产品的SKU

$sku = $anymarket->sku()->setProduct('ID_PRODUTO')->get(0, 50);

搜索产品的SKU

$sku = $anymarket->sku()->setProduct('ID_PRODUTO')->find('ID_SKU');

创建SKU

$sku = $anymarket->sku()->setProduct('ID_PRODUTO')->create([
    'title' => 'string',
    'partnerId' => 'string',
    'ean' => 'string',
    'amount' => 0,
    'price' => 0,
    'additionalTime' => 0,
    'variations' => [
        'variationName' => 'VariationValue'
    ]
]);

更新SKU

$sku = $anymarket->sku()->setProduct('ID_PRODUTO')->update('ID_SKU', [
     'title ' =>  'string ',
     'partnerId ' =>  'string ',
     'ean ' =>  'string ',
     'price ' => 0,
     'sellPrice ' => 0
]);

更新SKU标题

$sku = $anymarket->sku()->setProduct('ID_PRODUTO')->updateTitle('ID_SKU', 'TÍTULO')

更新SKU价格

$sku = $anymarket->sku()->setProduct('ID_PRODUTO')->updatePrice('ID_SKU', 12.00, 10.00);

变体

搜索所有变体

进行变体搜索需要传递offset和limit参数

$variation = $anymarket->variation()->get(0, 50);

搜索变体

$variation = $anymarket->variation()->find('ID_VARIAÇÃO');

创建变体

$variation = $anymarket->variation()->create([
    'name' => 'string',
    'partnerId' => 'string',
    'visualVariation' => true,
    'values' => [
        [
          'description' => 'string'
        ]
    ]
]);

更新变体

$variation = $anymarket->variation()->update('ID_VARIAÇÃO', [
    'name' => 'string',
    'partnerId' => 'string',
    'visualVariation' => true
]);

删除一个变体

$variation = $anymarket->variation()->delete('ID_VARIAÇÃO');

变体的值

在此资源中需要使用setVariation()方法

$anymarket->variationValue()->setVariation('ID_VARIAÇÃO')

搜索变体的值

$value = $anymarket->variationValue()->setVariation('ID_VARIAÇÃO')->get(0, 50);

搜索一个变体值

$value = $anymarket->variationValue()->setVariation('ID_VARIAÇÃO')->find('ID_VALOR');

为变体创建一个值

$value = $anymarket->variationValue()->setVariation('ID_VARIAÇÃO')->create([
    'description' => 'string',
    'partnerId' => 'string'
])

更新变体值

$value = $anymarket->variationValue()->setVariation('ID_VARIAÇÃO')->update('ID_VALOR', [
    'description' => 'string',
    'partnerId' => 'string'
]);

删除变体值

$value = $anymarket->variationValue()->setVariation('ID_VARIAÇÃO')->find('ID_VALOR');

库存

创建库存

$stock = $anymarket->stock()->create([
     'id '=> 0,
     'partnerId '=> 0,
     'quantity '=> 0,
     'cost '=> 0,
     'additionalTime '=> 0,
     'stockLocalId '=> 0
]);

更新库存

$stock = $anymarket->stock()->update('ID_SKU', [
     'id '=> 0,
     'partnerId '=> 0,
     'quantity '=> 0,
     'cost '=> 0,
     'additionalTime '=> 0,
     'stockLocalId '=> 0
]);

更新库存数量

$stock = $anymarket->stock()->updateStockQuantity('ID_SKU', 10);

更新库存价格

$stock = $anymarket->stock()->updatePrice('ID_SKU', 100.00);

搜索库存位置

$stock = $anymarket->stock()->getLocals()

品牌

搜索所有品牌

进行品牌搜索需要传递offset和limit参数

$brands = $anymarket->brand()->get(0, 50);

搜索品牌

$brands = $anymarket->brand()->find('ID_MARCA');

创建品牌

$brand = $anymarket->brand()->create([
    'name' => 'Nome da marca',
    'partnerId' => 'ID da marca no parceiro'
]);

更新品牌

$brand = $anymarket->brand()->update('ID_MARCA', [
    'name' => 'Atualização de marca'
]);

删除品牌

$brand = $anymarket->brand()->delete('ID_MARCA');

类别

搜索所有类别

进行类别搜索需要传递offset和limit参数

$category = $anymarket->category()->get(0, 50);

搜索类别

$category = $anymarket->category()->find('ID_CATEGORIA');

创建类别

$category = $anymarket->category()->create([
    'name' => 'Categoria',
    'partnerId' => '123',
    'priceFactor' => 1,
    'calculatedPrice' => true,
    'definitionPriceScope' => 'SKU'
]);

更新类别

$category = $anymarket->category()->update('ID_CATEGORIA', [
    'name' => 'Atualizar categoria',
    'partnerId' => '1234',
    'priceFactor' => 1,
    'calculatedPrice' => true,
    'definitionPriceScope' => 'SKU'
]);

删除类别

$category = $anymarket->category()->delete('ID_CATEGORIA');

订单

搜索所有订单

进行订单搜索需要传递offset和limit参数

$orders = $anymarket->order()->get(0, 50);

搜索订单

$orders = $anymarket->order()->find('ID_PEDIDO');

更新订单状态

$orders = $anymarket->order()->updateStatus('ID_PEDIDO', [
    'status' => 'string',
    'invoice' => [
        'accessKey' => 'string',
        'series' => 'string',
        'number' => 'string',
        'date' => '2019-04-23T13=>25=>53Z',
        'cfop' => 'string',
        'companyStateTaxId' => 'string'
    ]
]);

查询订单源

$orders = $anymarket->order()->feed()

更新订单源

$orders = $anymarket->order()->feedUpdate('ID_FEED', 'TOKEN_FEED');

回调

搜索所有回调

进行回调搜索需要传递offset和limit参数

$callbacks = $anymarket->callback()->get(0, 50);

搜索回调

$callback = $anymarket->callback()->find('ID_CALLBACK');

创建回调

$callback = $anymarket->callback()->create([
    'url' => 'URL de callback',
]);

更新回调

$callback = $anymarket->callback()->update('ID_CALLBACK', [
    'url' => 'URL de callback'
]);

删除回调

$callback = $anymarket->callback()->delete('ID_CALLBACK');