Loading...

Knowledge Base

Move Products Between Customers Using the API

When you want to transfer all products from one customer to another. This article explains how to move products between customer accounts using the API, including required parameters, contact handling behavior, IRTP-related changes, and TLD-specific restrictions for domains like .CN and .ES.


Description

Moves all products from one customer to other customer.

Parameters

NameData TypeRequired / OptionalDescription
auth-useridIntegerRequiredAuthentication Parameter
api-keyStringRequiredAuthentication Parameter
domain-nameStringRequiredDomain name that needs to be moved
existing-customer-idIntegerRequiredExisting Customer ID from which the products are to be transferred
new-customer-idIntegerRequiredNew Customer ID to which the products are to be transferred
default-contactStringRequired
Attention

This API Parameter will be deprecated from 1st December 2016 due to IRTP changes in the system. This parameter will not be required post 1st December 2016 as by default only the old contact can be used.

Value to indicate whether the old Contact has to be retained or to use the Default Contact of the new Customer. Valid entries are oldcontact or default.

Note

In case of a .CN domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact will be the only valid value.

Note

In case of a .ES domain name, the Default Contact of the new Customer cannot be associated with the domain name and the old Contact has to be retained. Hence, oldcontact will be the only valid value.

HTTP Method

POST

Example Test URL Request

https://test.httpapi.com/api/products/move.json?auth-userid=0&api-key=key&domain-name=domain.com&existing-customer-id=0&new-customer-id=0&default-contact=oldcontact

Response

Returns a hash map containing a status key with value as Success, if the move request is accepted by the system for processing.

In case of any errors, a status key with value as ERROR alongwith an error message will be returned.