Plentymarkets interface documentation

Credentials

Contracts

CredentialsRepositoryContract

The contract for the fitment repository.

Namespace

Plenty\Modules\Market\Credentials\Contracts

Methods
public get($id):Plenty\Modules\Market\Credentials\Models\Credentials
Return type: Credentials

Get credentials

Parameters

Name

Type

Description

$id

int

The ID of the credentials.

public create($data):Plenty\Modules\Market\Credentials\Models\Credentials
Return type: Credentials

Create credentials

Parameters

Name

Type

Description

$data

array

The credentials data. The properties that are required to update credentials can be found in the credentials model.

public update($id, $data):Plenty\Modules\Market\Credentials\Models\Credentials
Return type: Credentials

Update credentials

Parameters

Name

Type

Description

$id

int

The ID of the credentials.

$data

array

The credentials data. The properties that are required to update credentials can be found in the credentials model.

public delete($id):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

Delete credentials

Parameters

Name

Type

Description

$id

int

The ID of the credentials.

public all($filters = []):array

List all credentials

Parameters

Name

Type

Description

$filters

array

Credentials can be filtered by ID, market, status, environment.

Return type: PaginatedResult

List credentials

Parameters

Name

Type

Description

$filters

array

Credentials can be filtered by ID, market, status, environment.

$page

int

Current page of the response.

$itemsPerPage

int

The requested amount of credentials per result page.

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Credentials

The credentials model

Namespace

Plenty\Modules\Market\Credentials\Models

Properties
Name Type Description

id

int

The ID of the credentials.

environment

string

The environment for the credentials. Possible values: sandbox, production

status

string

The status of the credentials. Possible values: active, inactive, pending

data

array

The data of the credentials.

market

string

The market for the current credentials.

createdAt

The date that the credentials was created.

updatedAt

The date that the credentials was updated last.

Methods
public toArray()

Returns this model as an array.

AccountPolicy

Contracts

FulfillmentPolicyRepositoryContract

The contract for the eBay fulfillment policy repository.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Contracts

Methods
public get($id, $filters = []):Plenty\Modules\Market\Ebay\AccountPolicy\Models\FulfillmentPolicy
Return type: FulfillmentPolicy

Get a stored fulfillment policy based on ID.

Parameters

Name

Type

Description

$id

string

The ID of the policy that we want to get

$filters

array

A list of filters that are needed to get the corresponding policy. Available: `marketplaceId´, `credentialsId´.

PaymentPolicyRepositoryContract

The contract for the eBay payment policy repository.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Contracts

Methods
public get($id, $filters = []):Plenty\Modules\Market\Ebay\AccountPolicy\Models\PaymentPolicy
Return type: PaymentPolicy

Get a stored payment policy based on ID.

Parameters

Name

Type

Description

$id

string

The ID of the payment policy.

$filters

array

A list of filters that are needed to get the corresponding policy. Available: `marketplaceId´, `credentialsId´.

ReturnPolicyRepositoryContract

The contract for the eBay return policy repository.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Contracts

Methods
public get($id, $filters = []):Plenty\Modules\Market\Ebay\AccountPolicy\Models\ReturnPolicy
Return type: ReturnPolicy

Get a stored return policy based on ID.

Parameters

Name

Type

Description

$id

string

The ID of the policy that we want to get

$filters

array

A list of filters that are needed to get the corresponding policy. Available: `marketplaceId´, `credentialsId´.

Events

FulfillmentPolicyCreated

An event class fired after a new fulfillment policy is created.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($fulfillmentPolicy):void
Parameters

Name

Type

Description

$fulfillmentPolicy

FulfillmentPolicy

public getFulfillmentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\FulfillmentPolicy
Return type: FulfillmentPolicy

Get the FulfillmentPolicy instance.

FulfillmentPolicyDeleted

An event class fired after a new fulfillment policy is deleted.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($fulfillmentPolicy):void
Parameters

Name

Type

Description

$fulfillmentPolicy

FulfillmentPolicy

public getFulfillmentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\FulfillmentPolicy
Return type: FulfillmentPolicy

Get the FulfillmentPolicy instance.

FulfillmentPolicyEvent

A base event class for all fulfillment policy events. Each fulfillment policy events expects an FulfillmentPolicy model.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($fulfillmentPolicy):void
Parameters

Name

Type

Description

$fulfillmentPolicy

FulfillmentPolicy

public getFulfillmentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\FulfillmentPolicy
Return type: FulfillmentPolicy

Get the FulfillmentPolicy instance.

FulfillmentPolicyUpdated

An event class fired after a new fulfillment policy is updated.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($fulfillmentPolicy):void
Parameters

Name

Type

Description

$fulfillmentPolicy

FulfillmentPolicy

public getFulfillmentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\FulfillmentPolicy
Return type: FulfillmentPolicy

Get the FulfillmentPolicy instance.

PaymentPolicyCreated

An event class fired after a new payment policy is created.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($paymentPolicy):void
Parameters

Name

Type

Description

$paymentPolicy

PaymentPolicy

public getPaymentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\PaymentPolicy
Return type: PaymentPolicy

Get the PaymentPolicy instance.

PaymentPolicyDeleted

An event class fired after a new payment policy is deleted.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($paymentPolicy):void
Parameters

Name

Type

Description

$paymentPolicy

PaymentPolicy

public getPaymentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\PaymentPolicy
Return type: PaymentPolicy

Get the PaymentPolicy instance.

PaymentPolicyEvent

A base event class for all payment policy events. Each payment policy events expects an PaymentPolicy model.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($paymentPolicy):void
Parameters

Name

Type

Description

$paymentPolicy

PaymentPolicy

public getPaymentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\PaymentPolicy
Return type: PaymentPolicy

Get the PaymentPolicy instance.

PaymentPolicyUpdated

An event class fired after a new payment policy is updated.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($paymentPolicy):void
Parameters

Name

Type

Description

$paymentPolicy

PaymentPolicy

public getPaymentPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\PaymentPolicy
Return type: PaymentPolicy

Get the PaymentPolicy instance.

ReturnPolicyCreated

An event class fired after a new return policy is created.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($returnPolicy):void
Parameters

Name

Type

Description

$returnPolicy

ReturnPolicy

public getReturnPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\ReturnPolicy
Return type: ReturnPolicy

Get the ReturnPolicy instance.

ReturnPolicyDeleted

An event class fired after a new return policy is deleted.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($returnPolicy):void
Parameters

Name

Type

Description

$returnPolicy

ReturnPolicy

public getReturnPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\ReturnPolicy
Return type: ReturnPolicy

Get the ReturnPolicy instance.

ReturnPolicyEvent

A base event class for all return policy events. Each return policy events expects an ReturnPolicy model.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($returnPolicy):void
Parameters

Name

Type

Description

$returnPolicy

ReturnPolicy

public getReturnPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\ReturnPolicy
Return type: ReturnPolicy

Get the ReturnPolicy instance.

ReturnPolicyUpdated

An event class fired after a new return policy is updated.

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Events

Methods
public __construct($returnPolicy):void
Parameters

Name

Type

Description

$returnPolicy

ReturnPolicy

public getReturnPolicy():Plenty\Modules\Market\Ebay\AccountPolicy\Models\ReturnPolicy
Return type: ReturnPolicy

Get the ReturnPolicy instance.

Models

AmountType

The eBay amount type model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

currency

string

The base currency applied to the value field to establish a monetary amount. The currency is represented as a 3-letter ISO4217 currency code. For example, the code for the Canadian Dollar is CAD.

value

float

The value of the monetary amount in the specified currency.

Methods
public toArray()

Returns this model as an array.

CategoryType

The eBay category type model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

default

bool

If this value is set to true, it indicates that this policy is the default policy for the associated categoryTypes.name and marketplaceId pair

name

string

The category type to which the policy applies (motor vehicles or non-motor vehicles). Available values: MOTORS_VEHICLES, ALL_EXCLUDING_MOTORS_VEHICLES

Methods
public toArray()

Returns this model as an array.

Deposit

The eBay deposit model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

amount

AmountType

Deposits are used only with Motors listings and the amount value indicates the initial deposit that a buyer must make to purchase a motor vehicle. Deposits on motor vehicles can only be paid using PayPal, so if you specify a deposit amount, then you must also set the paymetMethodType value to 'PayPal'.

dueIn

TimeDuration

Indicates the number of hours the buyer has (after they commit to buy) to make an initial deposit to the seller as a down payment on a motor vehicle.

paymentMethods

PaymentMethod

A list of accepted payment methods. For deposits (which are applicable to only motor listings), the paymentMethodType must be set to 'PayPal'

Methods
public toArray()

Returns this model as an array.

FulfillmentPolicy

The eBay fulfillment policy model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

fulfillmentPolicyId

string

The ID of the fulfillment policy.

categoryTypes

array

The CategoryTypeEnum value to which this policy applies. Used to discern accounts that sell motor vehicles from those that don’t. (Currently, each policy can be set to only one categoryTypes value at a time.)

description

string

An optional seller-defined description of the fulfillment policy.

freightShipping

bool

Set this value to true to indicate the seller offers freight shipping.

globalShipping

bool

If this value is set to true, it indicates the seller has opted-in to the eBay Global Shipping Program and that they use that service for thier internation shipments.

handlingTime

TimeDuration

Specifies the maximum number of business days the seller commits to for preparing and shipping an order after receiving a cleared payment for the order.

localPickup

bool

If this value is set to true, it indicates the seller offers local pickup of their items.

marketplaceId

string

The ID of the eBay marketplace to which this fulfillment policy applies. If this value is not specified, value defaults to the seller’s eBay registration site.

name

string

A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

pickupDropOff

bool

If this value is set to true, it indicates the seller offers the "Click and Collect" feature.

shippingOptions

array

A list that defines the seller’s shipping configurations for DOMESTIC and INTERNATIONAL order shipments.

shipToLocations

RegionSet

This object contains the regionIncluded and regionExcluded fields, which indicate the areas to where the seller does and dosen’t ship.

Methods
public toArray()

Returns this model as an array.

PaymentMethod

The eBay payment method model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

brands

array

A list of credit card brands accepted by the seller. This field is required if the paymentMethodType is set to CREDIT_CARD.

paymentMethodType

string

The payment method, selected from the supported payment method types..

recipientAccountReference

RecipientAccountReference

Information that is used to identify the recipient’s account to which electronic funds are sent. This field is required if the payment method is set to PAYPAL, and the field must contain the email address associated with the PayPal account selected by the seller.

Methods
public toArray()

Returns this model as an array.

PaymentPolicy

The eBay payment policy model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

paymentPolicyId

string

The ID of the payment policy.

categoryTypes

array

The CategoryTypeEnum value to which this policy applies. The category type discerns whether the policy covers the sale of motor vehicles (via eBay Motors), or the sale of everything except motor vehicles.

deposit

Deposit

A container that describes the details of a deposit. Used only with motor listings.

description

string

An optional seller-defined description of the payment policy. (Max length: 250)

fullPaymentDueIn

TimeDuration

Indicates the number of days that a buyer has to make their full payment to the seller, and close the remaining balance on a motor vehicle transaction. The period starts when the buyer commits to buy.

immediatePay

bool

Indicate if the payment is due upon receipt or not. (eBay generates a receipt when the buyer agrees to purchase an item)

marketplaceId

string

The ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller’s eBay registration site.

name

string

A user-defined name for this payment policy. Names must be unique for policies assigned to the same marketplace. (Max length: 64)

paymentInstructions

string

Allows the seller to give payment instructions to the buyer. These instructions appear on the eBay View Item and Checkout pages.

paymentMethods

PaymentMethod

A list of the payment methods accepted by the seller. Each payment policy must specify at least one payment method.

Methods
public toArray()

Returns this model as an array.

RecipientAccountReference

The eBay recipient account reference model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

referenceId

string

The recipient’s reference.

referenceType

string

The reference type of a recipient’s account.

Methods
public toArray()

Returns this model as an array.

Region

The eBay region model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

regionName

string

A string that indicates the name of a region, as defined by eBay. A "region" can be either a 'world region' (e.g., the "Middle East" or "Southeast Asia") or a country, as represented with a two-letter country code.

regionType

string

Available values: COUNTRY, COUNTRY_REGION, STATE_OR_PROVINCE, WORLD_REGION, WORLDWIDE.

Methods
public toArray()

Returns this model as an array.

RegionSet

The eBay region set model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

regionExcluded

array

A list of one or more regionsName fields that specify the areas to where a seller does not ship. Populate regionExcluded in only the top-level shipToLocations container.

regionIncluded

array

A list of one or more regionsName fields that specify the areas to where a seller ships.

Methods
public toArray()

Returns this model as an array.

ReturnPolicy

The eBay return policy model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

returnPolicyId

string

The ID of the return policy.

categoryTypes

array

For return policies, this field can be set to only `ALL_EXCLUDING_MOTORS_VEHICLES (returns on motor vehicles are not processed through eBay flows.)

description

string

An optional seller-defined description of the return policy.

extendedHolidayReturnsOffered

bool

If this value is set to true, it indicates the seller offers an Extended Holiday Returns policy for their listings.

marketplaceId

string

The ID of the eBay marketplace to which this return policy applies. If this value is not specified, value defaults to the seller’s eBay registration site.

name

string

A user-defined name for this fulfillment policy. Names must be unique for policies assigned to the same marketplace.

refundMethod

string

Indicates the method the seller uses to compensate the buyer for returned items. The return method specified applies only to remorse returns. Available options: MERCHANDISE_CREDIT, MONEY_BACK.

restockingFeePercentage

string

Sellers who accept returns should include this field if they charge buyers a restocking fee when items are returned.

returnInstruction

string

This optional free-form string field lets the seller provide a detailed explanation of the return policy.

returnMethod

string

This field indicates the method in which the seller handles non-money back return requests for remorse returns. Sellers can specify they either exchange or replace items. Available options: EXCHANGE, REPLACEMENT.

returnPeriod

TimeDuration

This value indicates the length of time the seller accepts returns, the duration of which starts when the buyer receives the item.

returnsAccepted

bool

Set this value to true to indicate the seller accepts returns.

returnShippingCostPayer

string

The seller uses this value to specify whether the buyer or the seller is responsible for paying return shipping charges. The field can be set to either BUYER or SELLER.

Methods
public toArray()

Returns this model as an array.

ShippingOption

The eBay shipping option model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

costType

string

Defines whether the shipping cost is FLAT_RATE, CALCULATED, or NOT_SPECIFIED (for use with freight shipping and local pickup)

insuranceFee

AmountType

Sellers can offer international shipping insurance only when they ship to AU, FR, or IT. This value indicates the cost the buyer must pay to purchase shipping insurance for the items being shipped.

insuranceOffered

bool

When set to true, it indicates the seller offers shipping insurance.

optionType

string

Use this field to set the ShippingOption element to either DOMESTIC or INTERNATIONAL

packageHandlingCost

AmountType

A fee a seller can add to cover package and handling costs. This fee is in addition to the amount of the selected shipping service and this fee is included in the final shipping service costs in the output.

rateTableId

string

A unique eBay-assigned ID associated with a user-created shipping rate table.

shippingServices

array

Contains a list of shipping services offered for either DOMESTIC or INTERNATIONAL shipments.

Methods
public toArray()

Returns this model as an array.

ShippingService

The eBay shipping service model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

additionalShippingCost

AmountType

The cost of shipping each additional item if the same buyer purchases a multiple quantity of the same line item. This field is applicable for policies that cover multiple-quantity, fixed-price listings and is not applicable for policies that apply to single-quantity listings.

buyerResponsibleForPickup

bool

This field is only applicable to vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for picking up the vehicle. Otherwise, the seller should specify the vehicle pickup arrangements in the item description.

buyerResponsibleForShipping

bool

This field is applicable for only items listed in vehicle categories on eBay Motors (US and Canada). If set to true, the buyer is responsible for the shipment of the vehicle. Otherwise, the seller should specify the vehicle shipping arrangements in the item description.

cashOnDeliveryFee

AmountType

The value indicates the Cash on Delivery (COD) fee that the seller charges if the buyer uses the CASH_ON_DELIVERY payment method.

freeShipping

bool

The seller can set this flag to true if they want to offer free shipping to the buyer. This field can only be included and set to 'true' for the first domestic shipping service option specified in the shippingServices container

shippingCarrierCode

string

The shipping carrier, such as 'USPS', 'FedEx', 'UPS', and so on.

shippingCost

AmountType

For shipping options that use a FLAT_RATE cost type, the amount is the shipping cost for the selected shipping carrier and service. The amount supplied must exclude any additional shipping charges (such as the seller’s handling charges or insurance).

shippingServiceCode

string

The shipping service that the shipping carrier uses to ship an item. For example, an overnight, two-day delivery, or other type of service.

shipToLocations

RegionSet

This object contains the regionIncluded and regionExcluded fields that define the list of geographical regions that the seller ships to and the list of regions where they do not ship.

sortOrder

int

This integer value controls the order that this shipping service option appears in the View Item and Checkout pages, as related to the other specified shipping service options.

surcharge

AmountType

A fee that can be charged to US buyers when they have an item shipped via UPS or FedEx to Alaska, Hawaii or Puerto Rico.

Methods
public toArray()

Returns this model as an array.

TimeDuration

The eBay time duration model

Namespace

Plenty\Modules\Market\Ebay\AccountPolicy\Models

Properties
Name Type Description

unit

string

A time-measurement unit used to specify a period of time. Available values: MONTH, DAY, HOUR, CALENDAR_DAY, BUSINESS_DAY, MINUTE, SECOND, MILLISECOND

value

string

An amount of time, as measured by the time-measurement units specified in the unit field.

Methods
public toArray()

Returns this model as an array.

Api

Exceptions

InvalidEndPointException

InvalidEndPointException.

Namespace

Plenty\Modules\Market\Ebay\Api\Exceptions

Methods
public getMessage():void
public getCode():void
public getFile():void
public getLine():void
public getTrace():void
public getPrevious():void
public getTraceAsString():void

InvalidPropertyTypeException

InvalidPropertyTypeException.

Namespace

Plenty\Modules\Market\Ebay\Api\Exceptions

Methods
public getMessage():void
public getCode():void
public getFile():void
public getLine():void
public getTrace():void
public getPrevious():void
public getTraceAsString():void

UnknownPropertyException

InvalidPropertyTypeException.

Namespace

Plenty\Modules\Market\Ebay\Api\Exceptions

Methods
public getMessage():void
public getCode():void
public getFile():void
public getLine():void
public getTrace():void
public getPrevious():void
public getTraceAsString():void

Services

BaseRestService

The service for making eBay REST calls.

Namespace

Plenty\Modules\Market\Ebay\Api\Services

Methods
public __construct($config):void
Parameters

Name

Type

Description

$config

array

Configuration option values.

public static getConfigDefinitions():array

Returns definitions for each configuration option that is supported.

public getConfig($option = null, $default = null):void

Method to get the service's configuration.

Parameters

Name

Type

Description

$option

string

The name of the option whos value will be returned.

$default

public callOperation($name, $request = null):Plenty\Modules\Market\Ebay\Api\Types\BaseType
Return type: BaseType

Build API request and send.

Parameters

Name

Type

Description

$name

string

The name of the operation.

$request

BaseType

Request object containing the request information.

public getEbayHeaders():array

Derived classes must implement this method that will build the needed eBay http headers.

BaseWsdlService

The service for making eBay WSDL calls.

Namespace

Plenty\Modules\Market\Ebay\Api\Services

Methods
public __construct($config):void
Parameters

Name

Type

Description

$config

array

Configuration option values.

public static getConfigDefinitions():array

Returns definitions for each configuration option that is supported.

public getConfig($option = null, $default = null):void

Method to get the service's configuration.

Parameters

Name

Type

Description

$option

string

The name of the option whos value will be returned.

$default

public callOperation($name, $request, $responseClass):Plenty\Modules\Market\Ebay\Api\Types\BaseType
Return type: BaseType

Build API request and send.

Parameters

Name

Type

Description

$name

string

The name of the operation.

$request

BaseType

Request object containing the request information.

$responseClass

string

The name of the PHP class that will be created from the XML response.

public getEbayHeaders($operationName):array

Derived classes must implement this method that will build the needed eBay http headers.

Parameters

Name

Type

Description

$operationName

string

The name of the operation been called.

Types

Base64BinaryType

The service for eBay Base64BinaryType.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

BaseType

The service for base type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Can pass an associative array that will set the objects properties.

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

BooleanType

The service for boolean type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

DecimalType

The service for decimal type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

DoubleType

The service for double type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

IntegerType

The service for integer type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

RepeatableType

The service for repeatable type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Methods
public __construct($class, $property, $expectedType):void
Parameters

Name

Type

Description

$class

string

The name of the class that the property is a member of.

$property

string

The name of the property that acts like an array.

$expectedType

string

The type that values assigned to the array should be.

public offsetExists($offset):bool

Determines if the offset exists in the array.

Parameters

Name

Type

Description

$offset

int

The array index to check.

public offsetGet($offset):void

Returns the value of the given offset.

Parameters

Name

Type

Description

$offset

int

The array index.

public offsetSet($offset, $value):void

Sets a value for the given offset.

Parameters

Name

Type

Description

$offset

The array index or null to add the value to the end of the array.

$value

The value to add.

public offsetUnset($offset):void

Unsets the value of the given offset.

Parameters

Name

Type

Description

$offset

int

The array index.

public count():int
public current():void
public key():int

Move onto the next array index.

public rewind():void

Reset the array index to the start of the array.

public valid():bool

StringType

The service for string type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

TokenType

The service for token type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

URIType

The service for uri type.

Namespace

Plenty\Modules\Market\Ebay\Api\Types

Properties
Name Type Description

properties

xmlNamespaces

requestXmlRootElementNames

Methods
public __construct($values = []):void
Parameters

Name

Type

Description

$values

array

Optional properties and values to assign to the object.

public static getParentValues($properties, $values):array

Helper function to remove the properties and values that belong to a object's parent.

Parameters

Name

Type

Description

$properties

array

$values

array

public __get($name):void

PHP magic function that is called when getting a property.

Parameters

Name

Type

Description

$name

string

The property name.

public __set($name, $value):void

PHP magic function that is called when setting a property.

Parameters

Name

Type

Description

$name

string

The property name.

$value

Value assigned to the property.

public __isset($name):bool

PHP magic function that is called to determine if a property is set.

Parameters

Name

Type

Description

$name

string

The property name.

public __unset($name):void

PHP magic function that is called to unset a property.

Parameters

Name

Type

Description

$name

string

The property name.

public toRequestXml():string

Converts the object to a XML request string.

public elementMeta($elementName):void

Returns the meta data for a property.

Parameters

Name

Type

Description

$elementName

string

The element name.

public attachment($data = null, $mimeType = "application/octet-stream"):void

Method to get or set the object's attachment. Overrides any existing attachment is setting.

Parameters

Name

Type

Description

$data

If a string it is assumed to be the contents of the attachment. If an array copy its values across.

$mimeType

string

The MIME type of the attachment that will be used in the request. Defaults to application/octet-stream.

public hasAttachment():bool

Helper method to check if an object has an attachment.

public toArray():array

Helper method that returns an associative array of the object's properties and values.

Assign multiple values to an object.

Parameters

Name

Type

Description

$expression

string

A valid JMESPath expression

public setValues($class, $values = []):void

Assign multiple values to an object.

Parameters

Name

Type

Description

$class

string

The name of the class the properties belong to.

$values

array

Associative array of property names and their values.

Auth

Contracts

AuthServiceContract

The contract for the eBay authentication service.

Namespace

Plenty\Modules\Market\Ebay\Auth\Contracts

Methods
public refreshTokenByCredentialsId($credentialsId):void

Refresh credentials token and update.

Parameters

Name

Type

Description

$credentialsId

int

Category

Contracts

CategoryRepositoryContract

The contract for the Ebay category repository.

Namespace

Plenty\Modules\Market\Ebay\Category\Contracts

Methods
public get($id, $filters = [], $with = []):Plenty\Modules\Market\Ebay\Category\Models\Category
Return type: Category

Get category

Parameters

Name

Type

Description

$id

int

The ID of the category.

$filters

array

The filters that could be applied: 'marketplaceId'.

$with

array

The relations that should be loaded: 'path'

public all($filters = [], $with = []):array

List all categories

Parameters

Name

Type

Description

$filters

array

Categories can be filtered by ID and marketplace ID. The filters that could be applied: 'marketplaceId', 'categoryId'.

$with

array

The relations that should be loaded: 'path'

Models

Category

The category model

Namespace

Plenty\Modules\Market\Ebay\Category\Models

Properties
Name Type Description

id

int

The ID of the category.

parentId

int

The parent category ID.

name

string

The name of the category.

isLeaf

bool

Tells if the category is leaf.

children

array

Child categories.

path

array

The category path.

Methods
public toArray()

Returns this model as an array.

ItemSpecific

Contracts

ItemSpecificRepositoryContract

The contract for the Ebay category repository.

Namespace

Plenty\Modules\Market\Ebay\ItemSpecific\Contracts

Methods
public all($filters = []):array

List item specifics.

Parameters

Name

Type

Description

$filters

array

The filters that could be applied: 'categoryId', 'marketplaceId'.

Models

ItemSpecific

The eBay item specific model.

Namespace

Plenty\Modules\Market\Ebay\ItemSpecific\Models

Properties
Name Type Description

name

string

A recommended Item Specific name.

minValues

int

Minimum number of values that you can specify for this Item Specific.

maxValues

int

Maximum number of values that you can specify for this Item Specific.

selectionMode

string

Controls whether you can specify your own name and value in listing requests, or if you need to use a name and/or value that eBay has defined.

valueType

string

The data type (e.g., date) that eBay expects the value to adhere to in listing requests. Only returned if the data type is not Text. In some cases, more details about the data type are returned in the valueFormat field.

valueFormat

string

The format of the data type (e.g., date format) that eBay expects the item specific’s value to adhere to in listing requests. A data type identified by the valueType field may have different representations, and valueFormat specifies the precise format that is required.

helpText

string

Help-text defines the purpose of the Item Specific. The help text will be shown only when it is available for the particular Item Specific.

helpUrl

string

A page on the eBay Web site with context-specific help tips that provide useful information about this Item Specific. Only returned when an applicable page is available in the system.

variationPicture

string

Indicates whether the name (e.g., Color) can (or must) be used to classify the variation pictures

variationSpecifics

string

Indicates whether the recommended name/value pair can be used as variation attributes in a fixed-price listing call. For example, a given category could disable a name like Brand in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could enable a name like Size for variation specifics (in addition to recommending it for item specifics). If not returned, then the name/value can be used for both variation specifics and item specifics.

values

array

The available values.

Methods
public toArray()

Returns this model as an array.

Marketplace

Contracts

MarketplaceRepositoryContract

The contract for the Ebay marketplace repository.

Namespace

Plenty\Modules\Market\Ebay\Marketplace\Contracts

Methods
public all($filters = []):array

Get the list of all available eBay marketplaces.

Parameters

Name

Type

Description

$filters

array

You can pass multiple filters to search only custom marketplaces. Available filters: referrerId, marketplaceId, marketId, siteId.

public allEbay($filters = []):array

Get the list of all available eBay marketplaces.

Parameters

Name

Type

Description

$filters

array

You can pass multiple filters to search only custom marketplaces. Available filters: referrerId, marketplaceId, marketId, siteId.

Helpers

MarketplaceHelper

Helper class that allows getting information about an eBay marketplace more easily.

Namespace

Plenty\Modules\Market\Ebay\Marketplace\Helpers

Methods
public get($filters):Plenty\Modules\Market\Ebay\Marketplace\Models\Marketplace
Return type: Marketplace

Get marketplace data model based on filters.

Parameters

Name

Type

Description

$filters

array

public getMarketplaceId($filters):string

Get the marketplace ID based on given filters. Possible filters: marketplaceId, referrerId, marketId, siteId.

Parameters

Name

Type

Description

$filters

array

public getMarketplaceIds():array

Get all available marketplace IDs.

public getReferrerId($filters):string

Get the referrer ID based on given filters. Possible filters: marketplaceId, referrerId, marketId, siteId.

Parameters

Name

Type

Description

$filters

array

public getReferrerIds():array

Get all available referrer IDs.

public getSiteId($filters):string

Get the site ID based on given filters. Possible filters: marketplaceId, referrerId, marketId, siteId.

Parameters

Name

Type

Description

$filters

array

public getSiteIds():array

Get all available site IDs.

public getMarketId($filters):string

Get the market ID based on given filters. Possible filters: marketplaceId, referrerId, marketId, siteId.

Parameters

Name

Type

Description

$filters

array

public getMarketIds():array

Get all available market IDs.

public getCurrency($filters):string

Get the currency based on given filters. Possible filters: marketplaceId, referrerId, marketId, siteId.

Parameters

Name

Type

Description

$filters

array

public getShortcut($filters):string

Get the shortcut based on given filters. Possible filters: marketplaceId, referrerId, marketId, siteId.

Parameters

Name

Type

Description

$filters

array

Models

Marketplace

The eBay marketplace model.

Namespace

Plenty\Modules\Market\Ebay\Marketplace\Models

Properties
Name Type Description

siteId

int

The ID of the site exactly as eBay specifies it in the docs. This value is/was used in the old eBay SOAP APIs

marketplaceId

string

The ID of the marketplace exactly as eBay specifies it in the docs. This value is used in the new eBay REST APIs. Eg. EBAY_DE or EBAY-DE

marketId

int

System-Listing wide internal ID for the listing marketplace. This id occurs only in correlation with the listing DB tables.

referrerId

float

System wide internal ID for the marketplace. Use this instead of marketId whenever possible!

shortcut

string

The marketplace shortcut name.

currency

string

The currency used for the marketplace

Methods
public toArray()

Returns this model as an array.

PartsFitment

Contracts

FitmentItemPropertyRepositoryContract

The contract for the fitment item property repository.

Namespace

Plenty\Modules\Market\Ebay\PartsFitment\Contracts

Methods
public find($id):Plenty\Modules\Market\Ebay\PartsFitment\Models\FitmentItemProperty
Return type: FitmentItemProperty

Returns a fitment item property by an ID.

Parameters

Name

Type

Description

$id

int

The ID of the fitment item property that should be found.

public create($data, $id):Plenty\Modules\Market\Ebay\PartsFitment\Models\FitmentItemProperty
Return type: FitmentItemProperty

Creates a new fitment item property.

Parameters

Name

Type

Description

$data

array

The fitment item property data as associative array.

$id

int

The fitment item ID that the current property should belong to.

public update($data, $id):Plenty\Modules\Market\Ebay\PartsFitment\Models\FitmentItem
Return type: FitmentItem

Updates an existing fitment item property.

Parameters

Name

Type

Description

$data

array

The fitment item property data to update as associative array.

$id

int

The ID of the fitment item property that should be updated.

public delete($id):bool

Deletes a fitment item property. Returns true if the deletion was successful, otherwise false.

Parameters

Name

Type

Description

$id

int

The ID of the fitment item property that should be deleted.

FitmentItemRepositoryContract

The contract for the fitment item repository.

Namespace

Plenty\Modules\Market\Ebay\PartsFitment\Contracts

Methods
public find($id):Plenty\Modules\Market\Ebay\PartsFitment\Models\FitmentItem
Return type: FitmentItem

Returns a fitment item by an ID.

Parameters

Name

Type

Description

$id

int

The id of the fitment item that should be found.

public create($data, $id):Plenty\Modules\Market\Ebay\PartsFitment\Models\FitmentItem
Return type: FitmentItem

Creates a new fitment item.

Parameters

Name

Type

Description

$data

array

The fitment item data as associative array.

$id

int

The ID of the fitment that the current fitment item belongs to.

public update($data, $id):Plenty\Modules\Market\Ebay\PartsFitment\Models\FitmentItem
Return type: FitmentItem

Updates an existing fitment item.

Parameters

Name

Type

Description

$data

array

The fitment item data to update as associative array.

$id

int

The ID of the fitment item that should be updated.

public delete($id):bool

Deletes a fitment item. Returns true if the deletion was successful, otherwise false.

Parameters

Name

Type

Description

$id

int

The ID of the fitment item that should be deleted.

FitmentRepositoryContract

The contract for the fitment repository.

Namespace

Plenty\Modules\Market\Ebay\PartsFitment\Contracts

Methods
public find($id, $with = []):Plenty\Modules\Market\Ebay\PartsFitment\Models\Fitment
Return type: Fitment

Returns a fitment by an ID.

Parameters

Name

Type

Description

$id

int

The ID of the fitment that should be found.

$with

array

The relations to load in the Fitment instance. The relations available are 'items', 'items.properties'.

public create($data):Plenty\Modules\Market\Ebay\PartsFitment\Models\Fitment
Return type: Fitment

Creates a new fitment.

Parameters

Name

Type

Description

$data

array

The fitment data as associative array.

public update($data, $id):Plenty\Modules\Market\Ebay\PartsFitment\Models\Fitment
Return type: Fitment

Updates an existing fitment.

Parameters

Name

Type

Description

$data

array

The fitment data to update as associative array.

$id

int

The ID of the fitment that should be updated.

public delete($id):Plenty\Repositories\Models\DeleteResponse
Return type: DeleteResponse

Deletes a fitment. Returns true if the deletion was successful, otherwise false.

Parameters

Name

Type

Description

$id

int

The ID of the fitment that should be deleted.

Search fitments

Parameters

Name

Type

Description

$page

int

The default page that will be returned is page 1.

$itemsPerPage

int

The number of entries to be displayed per page. The default number of entries per page is 50.

$with

array

The relations to load in the Fitment instance. The relations available are 'items', 'items.properties'.

$filters

array

The filters that could be applied: 'id', 'categoryId', 'marketId', 'name', 'property', 'propertyName', 'propertyValue'.

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Fitment

The fitment model. This can contain multiple FitmentItems models.

Namespace

Plenty\Modules\Market\Ebay\PartsFitment\Models

Properties
Name Type Description

id

int

The id of the fitment.

marketId

int

The id of the market the fitment belongs to.

name

string

The name of the fitment.

categoryId

int

The id of the category the fitment belongs to.

items

array

The list of the items that belong to the fitment.

Methods
public toArray()

Returns this model as an array.

FitmentItem

The fitment item model. This belongs to one fitment model and can contain multiple FitmentItemProperty models.

Namespace

Plenty\Modules\Market\Ebay\PartsFitment\Models

Properties
Name Type Description

id

int

The id of the item that belongs to the fitment.

fitmentId

int

The id of the fitment.

fitment

Fitment

The fitment this fitment item belongs to.

properties

array

A collection of this fitment item properties. Available names are 'Make', 'Model', 'Platform', 'Type', 'Production Period', 'Engine', 'FitmentComments', 'KType'.

Methods
public toArray()

Returns this model as an array.

FitmentItemProperty

The fitment item property model. This bleongs to an FitmentItem model.

Namespace

Plenty\Modules\Market\Ebay\PartsFitment\Models

Properties
Name Type Description

id

int

The ID of the fitment item property.

fitmentItemId

int

The ID that the fitment item this property belongs to.

name

string

The name of the property

value

string

The value of the property.

fitmentItem

FitmentItem

The fitment item this property belongs to.

Methods
public toArray()

Returns this model as an array.

ShopCategory

Contracts

ShopCategoryRepositoryContract

The contract for the eBay shop categories.

Namespace

Plenty\Modules\Market\Ebay\ShopCategory\Contracts

Methods
public all($credentialsId, $viewType = "list"):array

Returns a fitment by an ID.

Parameters

Name

Type

Description

$credentialsId

int

The credentials ID for whom we want to load the eBay shop categories.

$viewType

string

How should the eBay shop categories be returned. Possible values: 'list' or 'tree'. Default is 'list'.

Transaction

Contracts

TransactionRepositoryContract

The contract for the ebay transaction repository.

Namespace

Plenty\Modules\Market\Ebay\Transaction\Contracts

Methods
public get($id):Plenty\Modules\Market\Ebay\Transaction\Models\Transaction
Return type: Transaction

Gets a transaction.

Parameters

Name

Type

Description

$id

int

The ID of the ebay transaction.

Search ebay transactions

Parameters

Name

Type

Description

$page

int

The default page that will be returned is page 1.

$itemsPerPage

int

The number of entries to be displayed per page. The default number of entries per page is 50.

$filters

array

The filters that could be applied: 'orderId', 'externalOrderId'.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

Models

Transaction

The ebay transaction model.

Namespace

Plenty\Modules\Market\Ebay\Transaction\Models

Properties
Name Type Description

id

int

The ID of the transaction.

orderId

int

The ID of the plentymarkets order.

market

string

The market. Possible values are: 'ebay', 'hood', 'ricardo'

externalListingId

string

The ID of the external listing.

credentialsId

string

The ID of the credentials.

buyerUserId

string

The ID of the ebay buyer.

feedback

int

The feedback.

transactionId

string

The ID of the ebay transaction.

endTime

The date that the item was bought.

quantity

int

The purchased quantity.

title

string

The title of the purchased item.

price

float

The price of the transaction.

shippingAddressCountry

string

The shipping address country.

referrerId

int

The ID of the order referrer.

createdAt

The date that the transaction was created.

notification

int

Flag that indicates if the transaction import was by notification.

orderRowId

int

The ID of the order row.

sku

string

The SKU.

lastUpdate

int

The date that the transaction was last updated.

externalOrderId

string

The ID of the external order.

externalReferenceNo

string

The external reference number.

cancelId

string

The ID of the cancellation.

isEbayPlus

string

The transaction is ebay plus. Possible values are: 'YES', 'NO'.

isClickAndCollect

string

The transaction is click and collect. Possible values are: 'YES', 'NO'.

extendedOrderId

string

The extended order ID of eBay.

importStatus

string

The current status of the order. Possible values are: 'NEW', 'IN_PROGRESS' and 'DONE'. Default is 'NEW'.

Methods
public toArray()

Returns this model as an array.

Helper

Contracts

MarketAccountHelperRepositoryContract

The contract for the market account helper repository.

Namespace

Plenty\Modules\Market\Helper\Contracts

Methods
public listMarketAccounts($marketId):array

List market accounts

Parameters

Name

Type

Description

$marketId

float

MarketAttributeHelperRepositoryContract

The contract for the market attribute helper repository.

Namespace

Plenty\Modules\Market\Helper\Contracts

Methods
public getAttributeName($id, $lang):string

Returns the attribute name for the given attribute id

Parameters

Name

Type

Description

$id

int

$lang

string

public getAttributeValueName($attributeId, $valueId, $lang):string

Returns the attribute value name for the given attribute value id

Parameters

Name

Type

Description

$attributeId

int

$valueId

int

$lang

string

public getAttributeNames($record, $lang = "de", $delimiter = ","):string

Returns all attribute names for the given language as a string delimited by the given delimiter.

Parameters

Name

Type

Description

$record

Record

$lang

string

$delimiter

string

public getAttributeValueSetShortFrontendName($record, $lang = "de", $delimiter = ", ", $attributeNameCombination = []):string

Returns the attribute value set short frontend name. Ex.: blue, XL

Parameters

Name

Type

Description

$record

Record

$lang

string

$delimiter

string

$attributeNameCombination

array

public getAttributeNameAndValueCombination($attributeNames, $attributeValues, $delimiter = ","):string

Returns the combination of attribute names with their attribute values.

Parameters

Name

Type

Description

$attributeNames

string

$attributeValues

string

$delimiter

string

public getVariationNameAndAttributeNameAndValueCombination($record, $lang):string

Returns the name for a variation with all attribute names and attribute values. Ex.: T-Shirt (Size: L, Color: red)

Parameters

Name

Type

Description

$record

Record

$lang

string

MarketCategoryHelperRepositoryContract

The contract for the market category helper repository.

Namespace

Plenty\Modules\Market\Helper\Contracts

Methods
public getCategoryBranchName($branchId, $lang, $plentyId, $separator = ">"):string

Returns the category bread crumbs as string for a given branchId, lang and plentyId

Parameters

Name

Type

Description

$branchId

int

$lang

string

$plentyId

int

$separator

string

default

MarketItemHelperRepositoryContract

The contract for the item helper repository.

Namespace

Plenty\Modules\Market\Helper\Contracts

Methods
public getExternalManufacturerName($manufacturerId):string

Get the external manufacturer name.

Parameters

Name

Type

Description

$manufacturerId

int

public generateSku($variationId, $marketId, $accountId, $setLastExportedTimestamp):string

Generates or updates the sku

Parameters

Name

Type

Description

$variationId

int

$marketId

float

$accountId

int

$setLastExportedTimestamp

bool

public getAvailability($availabilityId, $lang, $returnAvailabilityName):string

Returns the availability name or the availability average days

Parameters

Name

Type

Description

$availabilityId

int

$lang

string

$returnAvailabilityName

bool

MarketPropertyHelperRepositoryContract

The contract for the market property helper repository.

Namespace

Plenty\Modules\Market\Helper\Contracts

Methods
public getMarketProperty($referrerId):array

Returns a list of the market properties

Parameters

Name

Type

Description

$referrerId

float

Settings

Contracts

SettingsRepositoryContract

Use this interface to store and retrieve market specific settings.

Namespace

Plenty\Modules\Market\Settings\Contracts

Methods
Return type: PaginatedResult

List settings.

Parameters

Name

Type

Description

$filters

array

Settings can be filtered by ID, marketplace ID.

$page

int

Current page of the response.

$itemsPerPage

int

The requested amount of settings per result page.

public create($marketplaceId, $type, $settings):Plenty\Modules\Market\Settings\Models\Settings
Return type: Settings

Create market settings.

Parameters

Name

Type

Description

$marketplaceId

string

The marketplace ID that the settings belong to

$type

string

The type of settings. Possible values: shipping, attribute, category, property.

$settings

array

The settings that will be saved.

public update($settingsData, $id):void

Update one market settings entry.

Parameters

Name

Type

Description

$settingsData

array

$id

int

public get($id):Plenty\Modules\Market\Settings\Models\Settings
Return type: Settings

Return the settings for a given settings ID.

Parameters

Name

Type

Description

$id

int

The settings id.

public find($marketplaceId, $type = null):array

Find settings for a given marketplace ID and type.

Parameters

Name

Type

Description

$marketplaceId

string

The marketplace id for which to retrieve the settings

$type

string

The typo of settings that should be searched for. Possible values: shipping, attribute, category, property.

public delete($id):bool

Delete a setting.

Parameters

Name

Type

Description

$id

int

public deleteAll($marketplaceId, $type):void

Delete all settings for a given type and marketplace ID.

Parameters

Name

Type

Description

$marketplaceId

string

$type

string

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

Factories

SettingsCorrelationFactory

Factory that allows to store correlation between market settings and plentymarkets settings.

Namespace

Plenty\Modules\Market\Settings\Factories

Methods
public type($type):Plenty\Modules\Market\Settings\Factories\SettingsCorrelationFactory
Return type: SettingsCorrelationFactory

Set here the type of relation that should be created.

Parameters

Name

Type

Description

$type

string

The relation type. Possible values: shipping, attribute, category, property

public createRelation($settingsId, $correlationId):void

Use this method to create a relation of the chosen type.

Parameters

Name

Type

Description

$settingsId

int

The id of the market settings we want to create the relation for.

$correlationId

int

The id of the plentymarkets settings we want to create the relation to.

public createRelationWithParent($settingsId, $correlationId, $parentSettingsId):void

Use this method to create a relation of the chosen type.

Parameters

Name

Type

Description

$settingsId

int

The id of the market settings we want to create the relation for.

$correlationId

int

The id of the plentymarkets settings we want to create the relation to.

$parentSettingsId

int

The id of the parent market settings we want to create the relation to.

public clear($marketplaceId):void

Clear all relations for a given correlation type.

Parameters

Name

Type

Description

$marketplaceId

public all($marketplaceId):array

Get all correlations for a given marketplace ID.

Parameters

Name

Type

Description

$marketplaceId

public getSettingsByCorrelation($marketplaceId, $correlationId):void

Get a specific settings by marketplace id and correlation id.

Parameters

Name

Type

Description

$marketplaceId

$correlationId

int

public getAllSettingsByCorrelation($marketplaceId, $correlationId):void

Get a specific settings by marketplace id and correlation id.

Parameters

Name

Type

Description

$marketplaceId

$correlationId

int

public getSettingsByCorrelationAndParent($marketplaceId, $correlationId, $parentSettingsId):void

Get a specific settings by marketplace id and correlation id.

Parameters

Name

Type

Description

$marketplaceId

$correlationId

int

$parentSettingsId

int

public getSettingsByParent($marketplaceId, $parentSettingsId):void

List settings by marketplace id and parent settings id.

Parameters

Name

Type

Description

$marketplaceId

$parentSettingsId

int

public getAllSettingsByCorrelationAndParent($marketplaceId, $correlationId, $parentSettingsId):void

Get a specific settings by marketplace id and correlation id.

Parameters

Name

Type

Description

$marketplaceId

$correlationId

int

$parentSettingsId

int

Models

Settings

The market settings model.

Namespace

Plenty\Modules\Market\Settings\Models

Properties
Name Type Description

id

int

The ID of the market settings.

marketplaceId

int

The ID of the marketplace.

type

string

The type of the current market settings. Possible values are: attribute, attributeValue, property, category, shipping.

settings

array

The market settings for the current marketplace.

category

array

The category that these market settings are related to.

parcelServicePreset

array

The parcel service preset that these market settings are related to.

attribute

array

The attribute that these market settings are related to.

property

array

The property item that these market settings are related to.

attributeValue

array

The attributeValue that these market settings are related to.

Methods
public toArray()

Returns this model as an array.

Order

Events

BeforeNewOrderItemCreationEvent

Event which signals a new ebay order item before its creation.

Namespace

Plenty\Modules\Market\Ebay\Order\Events

Methods
public getData():void
public getWarehouseId():void
public setWarehouseId($warehouseId):void
Parameters

Name

Type

Description

$warehouseId

int

OrderItemEvent

Generic ebay order item event.

Namespace

Plenty\Modules\Market\Ebay\Order\Events

Methods
public getData():void
public getWarehouseId():void
public setWarehouseId($warehouseId):void
Parameters

Name

Type

Description

$warehouseId

int