Participants
Read participant profile
Read current participant profile
GET /participant-service/users/participant
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
{
"address": "Some Str.",
"city": "Some City",
"company_prefix": [
"00000935254"
],
"contact": "ContactName",
"country": "036",
"email": "foo@bar.ru",
"external_id": "321",
"facebook_url": "facebook.com/12345",
"gln": "123",
"name": "Name",
"parent": "urn:authenticateit:participant:1486463259613",
"participant_type": [
"manufacturer",
"system"
],
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/file2.png",
"phone": "+7111111111",
"post_code": "1234",
"state": "Some State",
"utc_time_zone": 12,
"budget": null
}
Edit participant profile
Current participant may edit the profile. The following parameters may be specified in request body:
name
— participant's name.country
,post_code
,state
,city
,address
— participant's address.email
— contact email address.phone
— contact phone number.contact
— contact person's name.facebook_url
— link to participant's Facebook profile.utc_time_zone
— UTC offset in hours (deprecated)gln
— GLN.external_id
— arbitrary external identifier.logo
— link to participant's logo.authentic_barcodes
— serialized GTINs of participant will have "Authentic Barcode" status when scanned.exclusive_info
— affects sources visibility in scans of products owned by participant. Only sources by participant will be visible iftrue
.api_domains
— list of participant domains from which Shping API will be requested for reviews etc.timezone_code
— timezone code.budget
— budget value (null
or non_neg_int).
PUT /participant-service/users/participant
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Example Request
{
"name": "Name",
"address": "Some Str.",
"city": "Some City",
"country": "036",
"contact": "ContactName",
"phone": "+7919186733",
"email": "foo@bar.ru",
"gln": "123",
"external_id": "321",
"state": "Some State",
"post_code": "1234",
"timezone_code":"Europe/Samara",
"logo":"http://dev-cdn.shping.com.s3.amazonaws.com/file2.png",
"facebook_url": "facebook.com/12345",
"budget": null,
"api_domains": [
"example.com",
"products.example.com"
]
}
Example Response
{
"address": "Some Str.",
"city": "Some City",
"company_prefix": [
"00000935254"
],
"contact": "ContactName",
"country": "036",
"email": "foo@bar.ru",
"external_id": "321",
"facebook_url": "facebook.com/12345",
"gln": "123",
"name": "Name",
"parent": "urn:authenticateit:participant:1486463259613",
"participant_type": [
"manufacturer"
],
"phone": "+7919186733",
"post_code": "1234",
"state": "Some State",
"timezone_code":"Europe/Samara",
"budget": null
}
Add participant
Create participant. Accepts JSON object with fields
company_prefix
(list of company prefixes for participant (prefix may
be "*"
)), participant_type
(imported_retailer
, expert
, manufacturer
, partner
,
product360
), name
(participant name) and country
(participant
country code). Responds with JSON representation of newly created
participant.
POST /participant-service/participants
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
company_prefix |
list | Prefixes |
issuer |
boolean | Issuer flag |
inn |
string | Inn attribute |
logo |
url | Logo |
participant_type |
string | Valid participant type |
name |
string | Required: Name (max 100) |
country |
string | Required: Country code |
Example Request. Expert
{
"name": "ACO Expert",
"company_prefix": [
"999949384",
"999949529"
],
"participant_type": "expert",
"country": "036"
}
Example Responce. Expert
{
"company_prefix": [
"999949384",
"999949529"
],
"country": "036",
"id": "urn:authenticateit:participant:73082866710077",
"name": "ACO Expert",
"parent": "urn:authenticateit:participant:1",
"participant_type": [
"expert"
]
}
Example Request. Imported_retailer
{
"name": "Costco NZ",
"logo": "https://dev-cdn.shping.com/2022/12/1/db982397-1a3a-4b13-92f6-16334a1345fe.jpg",
"participant_type": "imported_retailer",
"country": "554"
}
Example Responce. Imported_retailer
{
"company_prefix": [
"*"
],
"country": "554",
"id": "urn:authenticateit:participant:151789885391155",
"logo": "https://dev-cdn.shping.com/2022/12/1/db982397-1a3a-4b13-92f6-16334a1345fe.jpg",
"modules": [
"product360"
],
"name": "Costco NZ",
"name_alias": "costco_nz",
"parent": "urn:authenticateit:participant:1",
"participant_type": [
"imported_retailer"
]
}
Create serialization issuer
Create issuer participant. Current user will be nominated to new issuer participant. Issuer participant could not make new issuer.
POST /participant-service/participants
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
name |
body | Required: Issuer name |
inn |
body | Required: Issuer inn |
country |
body | Required: Issuer country |
issuer |
body | Required: Should be true |
Example Request
{
"name": "Test issuer",
"inn": "1234567890",
"country": "036",
"issuer": true
}
Example Responce
{
"company_prefix": [
"*"
],
"country": "036",
"id": "urn:authenticateit:participant:214910731629879",
"inn": "1234567890",
"issuer": true,
"modules": [
"product360",
"serialization",
"supply_chain"
],
"name": "Test issuer",
"packaging": {
"container_company_prefix": [
"*"
],
"item_company_prefix": [
"*"
]
},
"parent": "urn:authenticateit:participant:735879621218609",
"participant_type": [
"product360"
],
"sscc_company_prefix": "1234567890"
}
Get participants
GET /participant-service/users/participants
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Delete participant
DELETE /participant-service/participant/:participant_id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Update? participant
POST /participant-service/users/participant
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Example Request
{
"id": "urn:epc:sgln:0614141.12345.1",
"name": "Ugg",
"country" : "Australia"
}
Participant's team
The section describes methods for working with a participant's team. Already nominated user with role “security_admin” can add other user to registered participant.
Update library of contexts for T&T Operator access. System only
System can configure context list for any participant.
POST /participant-service/t&t/context
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
context | [string] | Required: List of contexts |
id | string | Required: Participant Id |
Example Request
{
"context": [{"id":"test1", "inn":"7704098732"}, {"id":"test3", "inn":"7705788023"}],
"id": "urn:authenticateit:participant:804355519238230"
}
Example Response
{
"list": [
{
"id": "test1",
"inn": "7704098732"
},
{
"id": "test3",
"inn": "7705788023"
}
]
}
Read library of contexts for T&T Operator access
System can read context for any participant by id
value. Participant can read only self context list (id
parameter will be ignored)
GET /participant-service/t&t/context
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | Participant Id (Required: for system) |
Example Response
{
"list": [
{
"id": "coty",
"inn": "7704098732",
"participant_id": "urn:authenticateit:participant:399530525345285"
},
{
"id": "seldico",
"inn": "7734170383",
"participant_id": "urn:authenticateit:participant:804355519238230"
},
{
"id": "shiseido",
"inn": "7705788023",
"participant_id": "urn:authenticateit:participant:834104793122303"
},
{
"id": "loreal",
"inn": "7726059896",
"participant_id": "urn:authenticateit:participant:207527590306155"
},
{
"id": "chanel",
"inn": "7702331790",
"participant_id": "urn:authenticateit:participant:158090513168288"
}
]
}
Set/Remove predefined contexts for T&T Operator
POST /participant-service/team/t&t/context
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | Required: User Id |
context | [string] | Required: List of contexts |
Example Request. Set contexts
{
"id": "urn:authenticateit:user:nickname:735879621218619:TT5",
"context":["test1", "test3"]
}
Example Response. Set contexts
{
"context": [
"test1",
"test3"
],
"id": "urn:authenticateit:participant:735879621218619",
"name": "User Name",
"roles": [
"product_line",
"report_viewer",
"reviews_admin",
"rewards_admin",
"security_admin",
"serialization_admin",
"serialization_viewer",
"supply_chain_admin"
]
}
Example Request. Remove contexts
{
"id": "urn:authenticateit:user:nickname:735879621218619:TT5",
"context":[]
}
Example Response. Remove contexts
{
"id": "urn:authenticateit:participant:735879621218619",
"name": "User Name",
"roles": [
"product_line",
"report_viewer",
"reviews_admin",
"rewards_admin",
"security_admin",
"serialization_admin",
"serialization_viewer",
"supply_chain_admin"
]
}
Set active context by user
PUT /participant-service/team/t&t/context/active
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string or null |
Required: Active context Id (null for reset) |
Example Request
{
"id":"test1"
}
Add/update user
Current user can add other registered users to team. Method must be used for invite user to participant's team or update user in team
POST /participant-service/team
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | email, facebook id, system id |
access_type | string | Admin , Content Writer , Moderator (for system only), RetailConnectOperator |
context | [string] | Predefined contexts for T&T Operator |
Example Response
[
{
"access_type": "Content Writer",
"first_name": "Sveta",
"id": "urn:authenticateit:user:email:my2@gmail.com",
"last_access": null,
"last_name": "LastName",
"ts": "2017-03-24T09:21:50Z"
},
{
"access_type": "Admin",
"id": "urn:authenticateit:user:email:foo@bar.com",
"last_access": "2017-03-24T09:12:41Z",
"ts": "2017-03-24T09:11:47Z"
}
]
Update operator profile
Method available only for users with role retail_connect_admin
to users with type RetailConnectOperator
PUT /participant-service/team
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | Required: User id |
password | string | New password |
Example Request
{
"password": "qwerty",
"id": "urn:authenticateit:user:email:my2@gmail.com"
}
Add/update user with specified roles
Current user can add other registered users to team with specified roles.
POST /participant-service/team
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | Required: email, facebook id, system id |
access_type | string | Required: Access type |
access_type
possible values: “Admin”, “Content Writer”, “Moderator” (for system participant only) or “RetailConnectOperator“
Example Response
[
{
"access_type": "Content Writer",
"first_name": "n",
"id": "urn:authenticateit:user:email:2qw@mailinator.com",
"last_access": null,
"last_name": "n",
"roles": [
"contributors_moderator"
],
"trusted_level": 1,
"trusted_rating": 0,
"ts": "2017-06-22T09:12:47Z"
},
{
"access_type": "Admin",
"id": "urn:authenticateit:user:email:foo@bar.com",
"last_access": "2017-03-24T09:12:41Z",
"ts": "2017-03-24T09:11:47Z"
}
]
Get participant's team
Get currents participant's team list
GET /participant-service/team
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
Example Response
[
{
"access_type": "Content Writer",
"first_name": "Sveta",
"id": "urn:authenticateit:user:email:test1@shping.com",
"email": "test1@shping.com",
"last_access": null,
"last_name": "LastName",
"ts": "2017-03-24T09:21:50Z"
},
{
"access_type": "Admin",
"id": "urn:authenticateit:user:email:test@shping.com",
"photo": "https://dev-cdn.shping.com/2021/6/30/7c8fb604-82bc-4574-b175-f577c2c1860f",
"email": "test@shping.com",
"last_access": "2017-03-24T09:12:41Z",
"ts": "2017-03-24T09:11:47Z"
},
{
"access_type": "T&T Operator",
"context": [
"test1"
],
"first_name": "TT3",
"id": "urn:authenticateit:user:nickname:735879621218619:TT3",
"last_access": null,
"photo": "https://dev-cdn.shping.com/2021/6/30/7c8fb604-82bc-4574-b175-f577c2c1860f",
"last_name": "TT3",
"participants": [
{
"id": "urn:authenticateit:participant:1",
"last_access": "2022-06-29T13:29:09Z",
"name": "Authenticateit Pty Ltd",
"roles": [
"billings:admin",
"ocr_user",
"product_line",
"receipt_mapping_moderator",
"report_viewer",
"reviews_admin",
"rewards_admin",
"security_admin"
]
}
],
"roles": [
"billings:admin",
"ocr_user",
"product_line",
"receipt_mapping_moderator",
"report_viewer",
"reviews_admin",
"rewards_admin",
"security_admin"
],
"ts": "2020-05-22T11:32:37Z"
}
]
Remove user from team
POST /participant-service/team/delete
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | email, facebook id, system id |
Example Response
[
{
"access_type": "Admin",
"id": "urn:authenticateit:user:email:foo@bar.com",
"last_access": "2017-03-24T09:12:41Z",
"ts": "2017-03-24T09:11:47Z"
}
]
Brands
Create New Brand DEPRECATED:
Takes JSON object containing unique brand name and URL of brand logo image.
POST /participant-service/brands
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
name |
string | Required: Brand name |
logo |
null or string |
Brand logo |
owner |
string | Only for system. To assign brand owner |
budget |
null or non_neg_int |
Brand budget |
Example Request
{
"name": "Ethertest_t_5",
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/Ethertest_t_5.png",
"owner": "urn:authenticateit:participant:735879621218609",
"budget": null
}
Example Response
{
"approved": false,
"budget": null,
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/Ethertest_t_5.png",
"name": "Ethertest_t_5",
"owner": "urn:authenticateit:participant:735879621218609"
}
Update Brand DEPRECATED:
Currently, only brand logo URL can be changed. Takes JSON object
containing name
of the brand and URL of brand logo image. Brand that
was already approved by parent participant couldn't be changed.
POST /participant-service/brands/update
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
name |
string | Required: Brand name |
logo |
null or string |
Brand logo |
owner |
string | Only for system. To assign brand owner |
budget |
null or non_neg_int |
Brand budget |
Example Request
{
"name": "Ethertest_t_1",
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/Ethertest_t_1.png",
"owner": "urn:authenticateit:participant:1",
"budget":20000
}
Example Response
{
"approved": false,
"budget": 20000,
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/Ethertest_t_1.png",
"name": "Ethertest_t_1",
"owner": "urn:authenticateit:participant:735879621218609",
"portfolio": "brand_portfolio:346849c3-46d5-46ec-84e0-05195bc3d1c2"
}
Delete Brand DEPRECATED:
Participant may delete own brands, which were not yet approved. Brand
name
must be sent in the request body.
POST /participant-service/brands/delete
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"name": "Koalabi Australia"
}
Approve Brand DEPRECATED:
Approve brand created by a child participant. Brand is identified by
name
in the request body.
POST /participant-service/brands/approve
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"name": "Koalabi Australia"
}
Example Response
{
"name": "Koalabi Australia",
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/koalabi2.png",
"owner": "urn:epc:sgln:0614141.12345.1",
"approved": true
}
Read Brands DEPRECATED:
Read list of brands.
Number of returned brands may be limited with the limit
parameter
(default valus is 100
). Number of brands may be skipped from the
list with the offset
parameter (0
by default).
Returned brands may be filtered by approved
status. System
participant receives brands of all participants, and may filter the
list of brands by owner
participant.
The resulting list is sorted by the brand name.
GET /participant-service/brands
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
offset |
Skip number of brands from the resulting list. | |
limit |
Limit the number of brands in the resulting list. | |
approved |
Only approved/not approved brands. | |
owner |
Applicable only for system. Only brands owned by this participant |
Example Response
{
"brands": [
{
"approved": false,
"budget": 20000,
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/Ethertest_t_1.png",
"name": "Ethertest_t_1",
"owner": "urn:authenticateit:participant:735879621218609",
"portfolio": "brand_portfolio:346849c3-46d5-46ec-84e0-05195bc3d1c2",
"portfolio_name": "Ethertest portfolio1"
},
{
"approved": false,
"budget": null,
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/Ethertest_t_1.png",
"name": "Ethertest_t_2",
"owner": "urn:authenticateit:participant:735879621218609",
"portfolio": "brand_portfolio:346849c3-46d5-46ec-84e0-05195bc3d1c2",
"portfolio_name": "Ethertest portfolio1"
},
{
"approved": false,
"budget": 20000,
"logo": "http://dev-cdn.shping.com.s3.amazonaws.com/Ethertest_t_1.png",
"name": "Ethertest_t_3",
"owner": "urn:authenticateit:participant:735879621218609",
"portfolio": null,
"portfolio_name": null
},
{
"approved": null,
"budget": null,
"logo": null,
"name": "Ethertest3",
"owner": "urn:authenticateit:participant:735879621218609",
"portfolio": null,
"portfolio_name": null
}
],
"count": 4,
"limit": 100,
"offset": 0
}
Brand Portfolio
Create portfolio
POST /participant-service/portfolio
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
name |
string | Required: Portfolio name |
brands |
list | Required: List of approved distributions |
owner |
string | Only for system. To assign owner |
budget |
null or non_neg_int |
Portfolio budget |
Example Request
{
"name": "Ethertest portfolio",
"owner": "urn:authenticateit:participant:735879621218609",
"brands":["urn:authenticateit:brand_distribution:c9b1ade4-5c1b-47de-8975-1bf7fedc8fdc"],
"budget":10000
}
Example Response
{
"brands": [
"urn:authenticateit:brand_distribution:c9b1ade4-5c1b-47de-8975-1bf7fedc8fdc"
],
"budget": 10000,
"created_by": "urn:authenticateit:participant:1",
"id": "brand_portfolio:e9f1f654-3067-486b-9761-c4775d7d951d",
"name": "Ethertest portfolio",
"owner": "urn:authenticateit:participant:735879621218609",
"type": "brand_portfolio"
}
Update portfolio
PUT /participant-service/portfolio
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Portfolio Id |
name |
string | Portfolio name |
brands |
list | List of approved distributions |
budget |
null or non_neg_int |
Portfolio budget |
Example Request
{
"id": "brand_portfolio:e9f1f654-3067-486b-9761-c4775d7d951d",
"name": "New name",
"brands": [
"urn:authenticateit:brand_distribution:c9b1ade4-5c1b-47de-8975-1bf7fedc8fdc"
],
"budget": 20000
}
Example Response
{
"brands": [
"urn:authenticateit:brand_distribution:c9b1ade4-5c1b-47de-8975-1bf7fedc8fdc"
],
"budget": 20000,
"created_by": "urn:authenticateit:participant:1",
"id": "brand_portfolio:e9f1f654-3067-486b-9761-c4775d7d951d",
"name": "New name",
"owner": "urn:authenticateit:participant:735879621218609",
"type": "brand_portfolio"
}
Delete portfolio
DELETE /participant-service/portfolio/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Portfolio Id |
Read portfolio
GET /participant-service/portfolio/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Required: Portfolio Id |
Example Response
{
"brands": [
"urn:authenticateit:brand_distribution:c9b1ade4-5c1b-47de-8975-1bf7fedc8fdc"
],
"budget": 10000,
"created_by": "urn:authenticateit:participant:1",
"id": "brand_portfolio:81f54632-1571-47c2-97e6-f137c5205c0a",
"name": "Ethertest portfolio",
"owner": "urn:authenticateit:participant:735879621218609",
"type": "brand_portfolio"
}
Read portfolio list
GET /participant-service/portfolio
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
offset |
Skip number of portfolios from the resulting list. | |
limit |
Limit the number of portfolios in the resulting list. | |
owner |
Applicable only for system. Only portfolios owned by this participant |
Example Response
{
"count": 1,
"limit": 100,
"list": [
{
"budget": 10000,
"id": "brand_portfolio:81f54632-1571-47c2-97e6-f137c5205c0a",
"name": "Ethertest portfolio",
"owner": "urn:authenticateit:participant:735879621218609"
}
],
"offset": 0
}
Brand Attachments DEPRECATED:
Attach GDTIs to a Brand
Link approved brand to existing GDTI documents. Request body must have
brand name
and attachments
list of document identifiers . Responds
with updated attachments
list of the brand.
Brand attachment positions may be overriden with
attachment_positions
in the request body. See product
attachments API description for more
information on attachment positions.
POST /participant-service/brands/attachments/add
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"name": "Wild Brand",
"attachments": [
"urn:epc:id:gdti:0000.00000005.004803474973806",
"urn:epc:id:gdti:0000.00000005.004819191780015"
],
"attachment_positions": {
"urn:epc:id:gdti:0000.00000005.004803474973806": 1,
"urn:epc:id:gdti:0000.00000005.004819191780015": null
}
}
Example Response
[
"urn:epc:id:gdti:0000.00000005.004803474973806",
"urn:epc:id:gdti:0000.00000005.004819191780015"
]
Detach GDTIs from a Brand
Unlink brand from GDTI documents. Request body must have brand name
and attachments
list of document identifiers to be
detached. Responds with updated attachments
list of the brand.
Attachment positions for the detached GDTIs will also be removed.
Positions for selected brand attachments may be removed by providing
attachment_positions
in the request body. See product
attachments API description for more
information.
POST /participant-service/brands/attachments/remove
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"name": "Wild Brand",
"attachments": [
"urn:epc:id:gdti:0000.00000005.004819191780015"
],
"attachment_positions": {
"urn:epc:id:gdti:0000.00000005.004803474973806": null
}
}
Example Response
[
"urn:epc:id:gdti:0000.00000005.004803474973806"
]
Marketing Profiles DEPRECATED:
Create New Marketing Profile
Takes JSON object containing marketing profile name, a set of conditions and a list of widgets.
POST /participant-service/marketing_profiles
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
name | string | Marketing profile name |
language | string | Language code in ISO format |
countries | array::string | Countries codes |
genders | array::string | e.g. ["male", "unknown"] |
min_age | number | Min age |
max_age | number | Max age |
min_date | string | e.g. "2016-12-19" |
max_date | string | e.g. "2016-12-29" |
min_scans | number | Min scans |
max_scans | number | Max scans |
register_methods | array::string | e.g. ["email", "facebook"] |
widgets | array:object | Array of widgets |
Example Response
{
"countries": [
"036",
"643"
],
"genders": [
"male",
"unknown"
],
"id": "urn:epc:id:gdti:123.3.842393846914558",
"language": "en",
"max_age": 30,
"max_date": "2016-12-25",
"max_scans": 15,
"min_age": 14,
"min_date": "2016-12-19",
"min_scans": 0,
"name": "Xyz",
"owner": "urn:epc:sgln:0614141.12345.1",
"register_methods": [
"email",
"facebook"
],
"widgets": [
{
"header": {
"text": "Xyz!"
}
},
{
"text": {
"lines": 2,
"text": "B",
"title": "A"
}
}
]
}
Attach Marketing Profile to a Trade Item
Attaches requested marketing profile to the trade item. Takes JSON object containing marketing profile identifier.
POST /participant-service/gtins/:id/marketing_profiles
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket | header | Required: Session's ticket |
id | string | Marketing profile id |
Supply Chain
Create Participant
Create child distributor or retailer for current participant. Takes JSON object containing participant fields.
There are fields for child participant's address (all required):
country
(country code)post_code
state
city
address
time_zone
(UTC offset in minutes; e.g., +03:00 is 180)
Supply chain related fields (all required):
type
(distributor
orretailer
)company_prefix
(list of company prefixes for the participant)gln
products
(non-empty list of associated GTINs)name
Fields for participant contact information:
phone
email
contact
(name of a person to contact)
Also there may be external_id
(arbitrary identifier) field for
external references.
To create child distributor or retailer current participant must have
active supply_chain
module and must have distributor
type. Also participants with module serialization
can create child
distributor
participants.
Current user is nominated with supply_chain_admin
role by newly
created participant.
POST /participant-service/supply_chain/participants
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"type": "distributor",
"external_id": "289",
"company_prefix": ["4603721"],
"name": "Two Toy",
"gln": "4603721111111",
"country": "643",
"city": "Novorossiysk",
"address": "Portovaya, 14",
"products": [
"46037211111111"
]
}
Example Response
{
"id": "urn:authenticateit:participant:655831267204784",
"parent": "urn:authenticateit:participant:827735452030300",
"participant_type": ["distributor"],
"external_id": "289",
"company_prefix": ["4603721"],
"name": "Two Toy",
"gln": "4603721111111",
"country": "643",
"city": "Novorossiysk",
"address": "Portovaya, 14",
"products": [
"46037211111111"
]
}
Import Participants
Create child distributor or retailer for current participant.
To create child distributor or retailer current participant must have
active supply_chain
module and must have distributor
type. Also participants with module serialization
can create child
distributor
participants.
POST /participant-service/supply_chain/import
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
user_id |
string | Nominated user |
list |
object | Required: List for import |
shipment_reg_mode
parameter inside list is optional and should be set to one of values: 010
, 020
, 030
, 031
, 040
, 050
, 060
, 070
, 080
, 090
transfer_type
parameter inside list is optional and should be set to one of values: 1
or 0
sscc_document
parameter inside list is optional and should be set to one of values: 1
or 0
Example Request
{
"user_id": "urn:authenticateit:user:email:test@test.com",
"list": [
{
"type": "distributor",
"external_id": "0",
"inn": "6027088229",
"shipment_reg_mode": "030",
"withdrawal_type": "Some Type",
"name": "ООО \"Вернисаж\"",
"transfer_type" :"1",
"sscc_document":"0"
},
{
"type": "distributor",
"external_id": "000050",
"inn": "7810912625",
"shipment_reg_mode": "020",
"name": "ЗАО \"Ленрианта\""
}
]
}
Example Response
{
"id": "154b246b-8fd9-4bd0-8ff2-f53db556c32e"
}
Import status
GET /participant-service/supply_chain/import/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
url | Required: Import Id |
Example Response
{
"status": "success"
}
Example Response
{
"status": "failed"
}
Example Response
{
"status": "pending"
}
Update Participant
Update child distributor or retailer participant. Takes JSON object containing fields to update (see description for Create Participant endpoint above for the list of fields).
PUT /participant-service/supply_chain/participants/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | distributor/retailer id |
Example Request
{
"external_id": "288",
"name": "Two Toyz"
}
Example Response
{
"id": "urn:authenticateit:participant:655831267204784",
"parent": "urn:authenticateit:participant:827735452030300",
"participant_type": ["distributor"],
"external_id": "288",
"company_prefix": ["4603721"],
"name": "Two Toyz",
"gln": "4603721111111",
"country": "643",
"city": "Novorossiysk",
"address": "Portovaya, 14",
"products": [
"46037211111111"
]
}
Read Participants
Read list of children distributors or retailers for current
participant. Parameter type
may be used to return only participants
of the specified type (distributor
or retailer
).
Number of returned participants may be limited with the limit
parameter
(default valus is 100
). Number of participants may be skipped from the list
with the offset
parameter (0
by default).
Returned participants may be filtered by type
(distributor
or
retailer
), external_id
, company_prefix
(supply chain participant
must have all of the specified prefixes to be included in the
response), name
, gln
, country
, post_code
, state
, city
,
address
, contact
, phone
, email
, products
(supply chain
participant must have all of the specified GTINs associated to be
included in the response).
The resulting list may be sorted. Parameter sort_by
should be used
to specify sorting field (external_id
, name
, gln
, country
,
post_code
, state
, city
, address
, contact
, time_zone
,
phone
and email
). Sorting order may be specified with sort_order
parameter (asc
for ascending order and desc
for descending order).
GET /participant-service/supply_chain/participants
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
type |
string | distributor or retailer |
offset |
Skip number of participants from the resulting list. | |
limit |
Limit the number of participants in the resulting list. | |
external_id |
Only participants with this external identifier. | |
company_prefix |
Only participants with all of these prefixes. | |
name |
Only participants with name matching this string. | |
gln |
Only participants with this GLN. | |
country |
Only participants with this country code. | |
post_code |
Only participants with this post code. | |
state |
Only participants with state mathching this string. | |
city |
Only participants with city matching this string. | |
address |
Only participants with address matching this string. | |
contact |
Only participants with contact name matching this string. | |
phone |
Only participants with this phone number. | |
email |
Only participants with email address matching this string. | |
products |
Only participants with all of these products associated. | |
sort_by |
Sort participants by field. | |
sort_order |
Ascending or descending sort order. |
Example Response
{
"participants": [
{
"id": "urn:authenticateit:participant:655831267204784",
"parent": "urn:authenticateit:participant:827735452030300",
"participant_type": [
"distributor"
],
"external_id": "288",
"company_prefix": ["4603721"],
"name": "Two Toyz",
"gln": "4603721111111",
"country": "643",
"city": "Novorossiysk",
"address": "Portovaya, 14",
"products": [
"46037211111111"
]
},
{
"id": "urn:authenticateit:participant:954339092655685",
"parent": "urn:authenticateit:participant:827735452030300",
"participant_type": [
"retailer"
],
"external_id": "354",
"company_prefix": ["4603721"],
"name": "Two Toyz Store",
"gln": "4603721111111",
"country": "643",
"city": "Novorossiysk",
"address": "Serebryakova, 2",
"products": [
"46037211111111"
]
}
],
"sort_by": "id",
"sort_order": "asc",
"offset": 0,
"limit": 100
}
Read Participant Business Locations
Read list of children distributors or retailers, but instead of
participant details include business_locations
list for each child
participant. See business locations API for description of location
JSON representation. Parameter type
may be used to return only
business locations for participants of the specified type
(distributor
or retailer
).
GET /participant-service/supply_chain/business_locations
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
type |
string | distributor or retailer |
Example Response
{
"participants": [
{
"id": "urn:authenticateit:participant:655831267204784",
"business_locations": [
{
"id": "2c2a486e-8b3f-4a61-a9ac-8400ffa4df73",
"sub_site_type": "207",
"name": "Storage Area",
"address": "Portovaya, 14",
"city": "Novorossiysk",
"state": "Krasnodar krai",
"post_code": "353909",
"country": "643",
"latitude": 44.7368214,
"longitude": 37.7784576,
"accuracy": 756
},
{
"id": "8a62195e-964d-46d5-a6bd-76fcdf330def",
"sub_site_type": "206",
"name": "Xyz",
"address": "Portovaya, 14",
"city": "Novorossiysk",
"state": "Krasnodar krai",
"post_code": "353909",
"country": "643",
"latitude": 44.7368214,
"longitude": 37.7784576,
"accuracy": 827
}
]
},
{
"id": "urn:authenticateit:participant:954339092655685",
"business_locations": []
}
]
}
Delete Participant
Delete child distributor or retailer for current participant.
DELETE /participant-service/supply_chain/participants/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | distributor/retailer id |
Business Locations
Create Location
Create a business location for participant. Takes JSON
object containing fields for business location address: country
(country code), post_code
, state
, city
, address
. Location
coordinates latitude
, longitude
, and coordinates accuracy
in
metres. Other fields are sub_site_type
(EPC global sub-site type
code), name
(location name). All fields are required.
Also could be set another optional fields:
url
, zone_id
, rrule
, alias
, location_type
(one of online_store
,retailer_store
,other
),
gln
Participant can create business locations for it's immediate child
supply chain participants. Identifier of child participant should be
provided in owner
parameter in this case.
POST /participant-service/business_locations
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"sub_site_type": "207",
"name": "Storage Area",
"address": "Elevatornaya, 22",
"city": "Novorossiysk",
"state": "Krasnodar krai",
"post_code": "353909",
"country": "643",
"latitude": 44736821,
"longitude": 37778457,
"accuracy": 378,
"url": "www.shping.com",
"rrule": "RRULE:FREQ=WEEKLY;BYDAY=WE,SA",
"alias": "WOOLOWRTHS-BRIGHTON",
"location_type": "online_store"
}
Example Response
{
"accuracy": 378,
"address": "Elevatornaya, 22",
"alias": "WOOLOWRTHS-BRIGHTON",
"city": "Novorossiysk",
"country": "643",
"id": "urn:authenticateit:business_location:9f4956c6-6f95-4cb7-9820-fd1b9fd952e3",
"latitude": 44736821,
"location_type": "online_store",
"longitude": 37778457,
"name": "Storage Area",
"owner": "urn:authenticateit:participant:1",
"post_code": "353909",
"rrule": "RRULE:FREQ=WEEKLY;BYDAY=WE,SA",
"state": "Krasnodar krai",
"sub_site_type": "207",
"url": "www.shping.com"
}
Update Location
Update business location data. Takes JSON object containing fields to change (see Create Location endpoint for the list of fields).
PUT /participant-service/business_locations/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Business location id |
Example Request
{
"sub_site_type": "207",
"name": "Storage Area",
"address": "Elevatornaya, 22",
"city": "Novorossiysk",
"state": "Krasnodar krai",
"post_code": "353909",
"country": "643",
"latitude": 44736821,
"longitude": 37778457,
"accuracy": 378,
"url": "www.shping.com",
"rrule": "RRULE:FREQ=WEEKLY;BYDAY=WE,SA",
"alias": "WOOLOWRTHS-BRIGHTON",
"location_type": "online_store",
"gln": "GLN"
}
Example Response
{
"accuracy": 378,
"address": "Elevatornaya, 22",
"alias": "WOOLOWRTHS-BRIGHTON",
"city": "Novorossiysk",
"country": "643",
"gln": "GLN",
"id": "urn:authenticateit:business_location:9f4956c6-6f95-4cb7-9820-fd1b9fd952e3",
"latitude": 44736821,
"location_type": "online_store",
"longitude": 37778457,
"name": "Storage Area",
"owner": "urn:authenticateit:participant:1",
"post_code": "353909",
"rrule": "RRULE:FREQ=WEEKLY;BYDAY=WE,SA",
"state": "Krasnodar krai",
"sub_site_type": "207",
"url": "www.shping.com"
}
Read Locations
Read list of participant's business locations.
Number of returned locations may be limited with the limit
parameter
(default valus is 100
). Number of locations may be skipped from the list
with the offset
parameter (0
by default).
Returned locations may be filtered by sub_site_type
, name
,
address
, city
, state
, post_code
, country
, zone_id
, alias
,
location_type
and gln
The resulting list may be sorted. Parameter sort_by
should be used
to specify sorting field (sub_site_type
, name
, address
, city
,
state
, post_code
, country
, zone_id
, alias
, location_type
or gln
).
Sorting order may be specified
with sort_order
parameter (asc
for ascending order and desc
for
descending order).
There is a parameter retrieve
to control which locations to
return. If it's value is own
(the default value), participant's own
business locations will be retrieved. If it's value is child
,
business locations of immediate child supply chain participant will be
retrieved. If it's all
both own and child locations will be present
in the response.
GET /participant-service/business_locations
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
offset |
Skip number of locations from the resulting list. | |
limit |
Limit the number of locations in the resulting list. | |
sub_site_type |
Only locations with this sub-site type. | |
name |
Only locations with name matching this string. | |
address |
Only locations with address mathching this string. | |
city |
Only with city matching this string. | |
state |
Only with state mathching this string. | |
post_code |
Only locations with this post code. | |
country |
Only locations with this country code. | |
zone_id |
Only locations with this zone_id | |
alias |
Only locations with alias matching this string. | |
location_type |
Only locations with this location_type | |
gln |
Only locations with this gln | |
sort_by |
Sort locations by field. | |
sort_order |
Ascending or descending sort order. | |
retrieve |
Retrieve own , child or all locations. |
Example Response
{
"business_locations": [
{
"accuracy": 378,
"address": "Elevatornaya, 22",
"alias": "WOOLOWRTHS-BRIGHTON",
"city": "Novorossiysk",
"country": "643",
"gln": "GLN",
"id": "urn:authenticateit:business_location:9f4956c6-6f95-4cb7-9820-fd1b9fd952e3",
"latitude": 44736821,
"location_type": "online_store",
"longitude": 37778457,
"name": "Storage Area",
"owner": "urn:authenticateit:participant:1",
"post_code": "353909",
"rrule": "RRULE:FREQ=WEEKLY;BYDAY=WE,SA",
"state": "Krasnodar krai",
"sub_site_type": "207",
"type": "business_location",
"url": "www.shping.com"
}
],
"count": 1,
"limit": 100,
"offset": 0,
"retrieve": "own",
"sort_by": "id",
"sort_order": "asc"
}
Delete Location
Delete participant's business location.
DELETE /participant-service/business_locations/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
string | Business location id |
Serialized Products Reassignment
Create Reassignment Task
Reassign set of serialized products to a new supply chain participant. Takes JSON object containing reassignment description.
Products are selected from current participant's serialized products
indexing table
with a query
. See RSQL API from Index service for
description of table
, query
and op
parameters. Indexing table
must be of sgtin
, lgtin
or slgtin
type.
To specify new owner of serialized products, use location
or
participant
parameters. If participant
provided, it must be
identifier of a child supply chain participant. If location
is
specified, it must be business location identifier and location's
owner will be used as participant
.
Responds with JSON representation of newly created reassignment
task. Task has id
which should be used to query task status and
progress. Field count
in task representation will contain total
number of products selected for reassignment.
POST /participant-service/supply_chain/reassignments
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"table": "index_schema_table_slgtin_aeb5afdf-aa5c-439c-b20d-9504bebf7ecf",
"query": "id==urn:epc:id:sgtin:084556643.0001.000000000000044;id==urn:epc:id:sgtin:084556643.0001.000000000000043;id==urn:epc:id:sgtin:084556643.0001.000000000000042",
"op": "OR",
"participant": "urn:authenticateit:participant:868695661420695"
}
Example Response
{
"id": "44ff192c-a88d-4089-a534-5f66beafcc78",
"created": "2018-05-14T21:33:51Z",
"count": 3,
"progress": 0
}
Read Reassignment Task
Query reassignment task status and progress.
GET /participant-service/supply_chain/reassignments/:id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
Reassignment task identifier. |
Example Response
{
"count": 3,
"created": "2018-05-14T21:33:51Z",
"end_time": "2018-05-14T21:33:53Z",
"id": "44ff192c-a88d-4089-a534-5f66beafcc78",
"op": "OR",
"owner": "urn:authenticateit:participant:266730991497899",
"participant": "urn:authenticateit:participant:868695661420695",
"progress": 3,
"query": "id==urn:epc:id:sgtin:084556643.0001.000000000000044;id==urn:epc:id:sgtin:084556643.0001.000000000000043;id==urn:epc:id:sgtin:084556643.0001.000000000000042",
"real_ip": "95.211.138.15",
"start_time": "2018-05-14T21:33:51Z",
"status": "done",
"table": "index_schema_table_slgtin_aeb5afdf-aa5c-439c-b20d-9504bebf7ecf",
"user_agent": "curl/7.52.1"
}
Brand Constraints
Current participant must be system to access this API. Only
participants of type product360
may have constraints.
Read Constraints
Read brand constraints for the specified participant. Responds with
JSON object containing lists of countries
and products
. Each
product has id
(GTIN) and name
(may be null
if name is unknown).
GET /participant-service/participants/:id/constraints
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket. |
id |
string | Participant identifier. |
Example Response
{
"countries": [
"036"
],
"products": [
{
"id": "09212345000015",
"name": "Muesli Bar 185g"
},
{
"id": "09212345000022",
"name": null
}
]
}
Set Constraints
PUT /participant-service/participants/:id/constraints
Set brand constraints for the participant. Takes JSON object with
optional countries
and products
lists. To clear the constraint,
set it to null
.
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket. |
id |
string | Participant identifier. |
Example Request
{
"countries": null,
"products": [
"09212345000022",
"09212345000015"
]
}
Add Constraints
Add to the existing constraints of the participant. Takes JSON object
with optional lists of countries
and products
to add.
POST /participant-service/participants/:id/constraints/add
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket. |
id |
string | Participant identifier. |
Example Request
{
"countries": [
"643"
],
"products": [
"09212345000220"
]
}
Remove Constraints
Remove from existing constraints of the participant. Takes JSON object
with optional lists of countries
and products
to remove.
POST /participant-service/participants/:id/constraints/remove
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Session ticket. |
id |
string | Participant identifier. |
Example Request
{
"countries": [
"643"
],
"products": [
"09212345000015"
]
}
Brand hierarchy
To fix the structure, a null
(default) brand was allocated. null
brand = urn:authenticateit:brand:00000000-0000-0000-0000-000000000000
.
This means that the distribution is not linked to the brand.
Brand management
Methods are available only for the system participant.
Create Brand
POST /participant-service/v2/brands
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
name |
body | Required: Brand name {maxlen, 100} |
registration_number |
body | Required: int or text {maxlen, 100} |
registration_country |
body | Required: country code |
company_id |
body | null or valid company_id |
description |
body | null or text {maxlen, 255} |
link |
body | null or URL |
logo |
body | null or URL |
website |
body | null or URL |
status |
body | null or text {maxlen, 255} |
kind |
body | null or text {maxlen, 255} |
class |
body | list |
source_image_description |
body | null or text {maxlen, 255} |
source_image |
body | null or URL |
source_image_tags |
body | list |
word |
body | null or {maxlen, 255} |
legal |
body | null or {maxlen, 512} |
ts_renewal_due |
body | null or ts |
ts_filling |
body | null or ts |
ts_registered_from |
body | null or ts |
Example Request
{
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"website": "https://shping.com",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"description": "For test only. Next3",
"name": "Name",
"registration_number": 90762222,
"registration_country": "036",
"status": "Registered/protected",
"kind": "Figurative",
"class": [
{
"class_id": "30",
"class_description": "Flour"
}
],
"source_image_description": "UNICORN",
"source_image": "https://cdn2.search.ipaustralia.gov.au/392/TRADE_MARK/T21346271/1.0/T21346271.MEDIUM.JPG",
"source_image_tags": [
"ANIMAL",
"UNICORN"
],
"word": "SUPERB",
"legal": "This mark was registered under the Trade Marks Act 1955 in Part A\n",
"ts_renewal_due": "2022-10-10T00:00:00.000Z",
"ts_filling": "2022-10-10T00:00:00.000Z",
"ts_registered_from": "2022-10-10T00:00:00.000Z"
}
Example Response
{
"alias": "036-90762222",
"approved": true,
"class": [
{
"class_description": "Flour",
"class_id": "30"
}
],
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"created_at": "2022-12-14T01:43:27Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "For test only. Next3",
"id": "urn:authenticateit:brand:006f8fc6-e6dc-4a78-957f-c58f6db17c67",
"kind": "Figurative",
"legal": "This mark was registered under the Trade Marks Act 1955 in Part A\n",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Name",
"owner": "urn:authenticateit:participant:1",
"registration_country": "036",
"registration_number": "90762222",
"source_image": "https://cdn2.search.ipaustralia.gov.au/392/TRADE_MARK/T21346271/1.0/T21346271.MEDIUM.JPG",
"source_image_description": "UNICORN",
"source_image_tags": [
"ANIMAL",
"UNICORN"
],
"status": "Registered/protected",
"ts_filling": "2022-10-10T00:00:00Z",
"ts_registered_from": "2022-10-10T00:00:00Z",
"ts_renewal_due": "2022-10-10T00:00:00Z",
"updated_at": "2022-12-14T01:43:27Z",
"website": "https://shping.com",
"word": "SUPERB"
}
Update Brand
PUT /participant-service/v2/brands
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: brand_id |
name |
body | Brand name {maxlen, 100} |
company_id |
body | null or valid company_id |
description |
body | null or text {maxlen, 255} |
link |
body | null or URL |
logo |
body | null or URL |
website |
body | null or URL |
deleted_flag |
body | Boolean |
status |
body | null or text {maxlen, 255} |
kind |
body | null or text {maxlen, 255} |
class |
body | list |
source_image_description |
body | null or text {maxlen, 255} |
source_image |
body | null or URL |
source_image_tags |
body | list |
word |
body | null or {maxlen, 255} |
legal |
body | null or {maxlen, 512} |
ts_renewal_due |
body | null or ts |
ts_filling |
body | null or ts |
ts_registered_from |
body | null or ts |
Example Request
{
"company_id": null,
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"website": "https://shping.com",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"description": "Fixed description",
"name": "FIRST brand",
"id": "urn:authenticateit:brand:006f8fc6-e6dc-4a78-957f-c58f6db17c67",
"deleted_flag": false
}
Example Response
{
"alias": "036-90762222",
"approved": true,
"company_id": null,
"created_at": "2022-12-14T01:43:27Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"deleted_flag": false,
"description": "Fixed description",
"id": "urn:authenticateit:brand:006f8fc6-e6dc-4a78-957f-c58f6db17c67",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "FIRST brand",
"owner": "urn:authenticateit:participant:1",
"registration_country": "036",
"registration_number": "90762222",
"updated_at": "2022-12-14T01:44:58Z",
"website": "https://shping.com"
}
Import brands
POST /participant-service/v2/brands/upsert/batch
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
list |
body | Required: List |
Example Request
{
"list": [
{
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"website": "https://shping.com",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"description": "For test only. Next3",
"name": "New Brand for create test import",
"registration_number": 90,
"registration_country": "036",
"status": "Registered/protected",
"kind": "Figurative",
"class": [
{
"class_id": "30",
"class_description": "Flour"
}
],
"source_image_description": "UNICORN",
"source_image": "https://cdn2.search.ipaustralia.gov.au/392/TRADE_MARK/T21346271/1.0/T21346271.MEDIUM.JPG",
"source_image_tags": [
"123",
"UNICORN"
],
"word": "SUPERB",
"legal": "This mark was registered under the Trade Marks Act 1955 in Part A\n",
"ts_renewal_due": "2022-10-10T00:00:00.000Z",
"ts_filling": "2022-10-10T00:00:00.000Z",
"ts_registered_from": "2022-10-10T00:00:00.000Z"
},
{
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"website": "https://shping.com",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"description": "For test only. Next3",
"name": "test brand import 5",
"registration_number": "00222",
"registration_country": "036",
"status": "Registered/protected",
"kind": "Figurative",
"class": [
{
"class_id": "30",
"class_description": "Flour"
}
],
"source_image_description": "UNICORN",
"source_image": "https://cdn2.search.ipaustralia.gov.au/392/TRADE_MARK/T21346271/1.0/T21346271.MEDIUM.JPG",
"source_image_tags": [
"123",
"UNICORN"
],
"word": "SUPERB",
"legal": "This mark was registered under the Trade Marks Act 1955 in Part A\n",
"ts_renewal_due": "2022-10-10T00:00:00.000Z",
"ts_filling": "2022-10-10T00:00:00.000Z",
"ts_registered_from": "2022-10-10T00:00:00.000Z"
}
]
}
Example Response
{
"list": [
{
"alias": "036-90",
"id": "urn:authenticateit:brand:d5444392-056e-414a-ab51-07e0c1a507e1",
"name": "New Brand for create test import",
"status": "created",
"link_company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"unlink_company_id": null
},
{
"alias": "036-00222",
"id": "urn:authenticateit:brand:f4ffa7a4-ff9e-47c1-a261-27fbd86fb178",
"name": "test brand import 5",
"status": "updated",
"link_company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"unlink_company_id": null
}
]
}
Read Brand
POST /participant-service/v2/brands/read
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: brand_id |
Example Request
{
"id": "urn:authenticateit:brand:b37e0614-18d7-4c9a-99d6-dfa2c94979ad"
}
Example Response
{
"alias": "036-rrrrrrr",
"approved": true,
"class": [
{
"class_description": "Flour",
"class_id": "30"
}
],
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"created_at": "2022-12-14T01:30:15Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "For test only. Next3",
"id": "urn:authenticateit:brand:53a3e307-34f2-4111-9dc4-2d042b28cd2f",
"kind": "Figurative",
"legal": "This mark was registered under the Trade Marks Act 1955 in Part A\n",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "New Brand for create test import",
"owner": "urn:authenticateit:participant:1",
"products_num": 0,
"registration_country": "036",
"registration_number": "rrrrrrr",
"source_image": "https://cdn2.search.ipaustralia.gov.au/392/TRADE_MARK/T21346271/1.0/T21346271.MEDIUM.JPG",
"source_image_description": "UNICORN",
"source_image_tags": [
"123",
"UNICORN"
],
"status": "Registered/protected",
"ts_filling": "2022-10-10T00:00:00Z",
"ts_registered_from": "2022-10-10T00:00:00Z",
"ts_renewal_due": "2022-10-10T00:00:00Z",
"updated_at": "2023-01-25T06:35:00Z",
"website": "https://shping.com",
"word": "SUPERB"
}
Delete Brand
POST /participant-service/v2/brands/delete
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: brand_id |
Example Request
{
"id": "urn:authenticateit:brand:b37e0614-18d7-4c9a-99d6-dfa2c94979ad"
}
Example Response
{
"alias": "036-90762222",
"approved": true,
"company_id": null,
"created_at": "2022-07-01T06:14:39Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"deleted_at": "2022-07-01T06:53:02Z",
"deleted_flag": true,
"description": "Fixed description",
"id": "urn:authenticateit:brand:b37e0614-18d7-4c9a-99d6-dfa2c94979ad",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "FIRST brand",
"owner": "urn:authenticateit:participant:1",
"updated_at": "2022-07-01T07:07:01Z",
"website": "https://shping.com",
"registration_country": "036",
"registration_number": "90762222",
}
Read Brands
POST /participant-service/v2/brands/list
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
company_id |
body | Company id filter |
alias |
body | Alias substring (length from 0 to 100) |
name |
body | Name substring (length from 0 to 100) |
deleted_flag |
body | Deleted filter (boolean) |
created_at_from |
body | Datetime filter |
created_at_to |
body | Datetime filter |
limit |
body | Limit (from 1) |
offset |
body | Offset (from 0) |
order_type |
body | Order type (asc or desc ) |
order_by |
body | Order parameter |
order_by
may be one of fields: id
, company_id
, alias
, name
, created_at
, updated_at
, deleted_at
, deleted_flag
Example Request
{
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"name": "brand",
"deleted_flag": false,
"created_at_from": "2022-01-01T01:01:01Z",
"created_at_to": "2022-09-01T01:01:01Z",
"order_type": "desc",
"order_by": "updated_at",
"limit": 1,
"offset": 0
}
Example Response
{
"count": 3,
"data": [
{
"alias": "036-90762222",
"approved": 1,
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"created_at": "2022-12-14T01:43:27Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"deleted_at": "2022-12-14T01:47:15Z",
"deleted_flag": 1,
"products_num": null,
"id": "urn:authenticateit:brand:006f8fc6-e6dc-4a78-957f-c58f6db17c67",
"link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "FIRST brand",
"owner": "urn:authenticateit:participant:1",
"registration_country": "036",
"registration_number": "90762222",
"status": null,
"ts_filling": null,
"ts_registered_from": null,
"ts_renewal_due": null,
"updated_at": "2022-12-14T01:47:15Z",
"website": "https://shping.com"
},
{
"alias": "036-1994156",
"approved": 1,
"class_ids": "28",
"company_id": "urn:authenticateit:brand_company:e8cd09eb-9819-4c8b-800a-c3feb53ad443",
"created_at": "2022-12-07T00:02:57Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"deleted_at": null,
"deleted_flag": null,
"products_num": 0,
"id": "urn:authenticateit:brand:94e922b7-d03d-4e3f-84c4-623e8e5d4060",
"kind": "Word",
"link": null,
"logo": null,
"name": "ORGAN ATTACK!",
"owner": "urn:authenticateit:participant:1",
"products_num": 0,
"registration_country": "036",
"registration_number": "1994156",
"source_image": null,
"status": "protected:\nRegistered/protected",
"ts_filling": "2019-02-06T13:00:00Z",
"ts_registered_from": "2019-02-06T13:00:00Z",
"ts_renewal_due": "2029-02-06T13:00:00Z",
"updated_at": "2022-12-07T00:02:57Z",
"website": null
},
]
}
Distribution management
Distribution is an link between brand and participant.
System participant have full access for distributions. Non System allow only create new distribution (if not exist).
Create Distribution. From participant
POST /participant-service/v2/brands/distributions
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
brand_name |
body | Required: Brand name {maxlen, 100} |
country |
body | Required: Country code |
name |
body | Required: Distribution name {maxlen, 100} |
link |
body | null or url |
notes |
body | null or text {maxlen, 255} |
logo |
body | null or URL |
company_id |
body | Valid company_id |
priority |
body | Int priority |
Example Request
{
"brand_name": "MY LOCAL BRAND NAME",
"country": "036",
"notes": "Some text notes",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"address": "Melbourne VIC 3004",
"name": "Distribution name 036",
"company_id": null,
"priority": 10
}
Example Response
{
"address": "Melbourne VIC 3004",
"brand_alias": "my_local_brand_name",
"brand_id": null,
"brand_name": "MY LOCAL BRAND NAME",
"country": "036",
"created_at": "2022-07-01T07:23:01Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "urn:authenticateit:brand_distribution:b0bf6f64-2752-44cc-9205-af99b1af6399",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Distribution name 036",
"notes": "Some text notes",
"participant_id": "urn:authenticateit:participant:708023102856412",
"status": "pending",
"updated_at": "2022-07-01T07:23:01Z",
"company_id": null,
"priority": 10
}
Create Distribution. From system
POST /participant-service/v2/brands/distributions
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
brand_id |
body | Required: Brand id |
country |
body | Required: Country code |
participant_id |
body | Required: Valid participant id |
name |
body | Required: Distribution name {maxlen, 100} |
budget |
body | null or non_neg_int |
link |
body | null or url |
notes |
body | null or text {maxlen, 255} |
logo |
body | null or URL |
company_id |
body | Valid company_id |
priority |
body | Int priority |
Example Request
{
"brand_name": "MY LOCAL BRAND NAME",
"country": "036",
"brand_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"notes": "Some text notes",
"participant_id": "urn:authenticateit:participant:708023102856412",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"address": "Melbourne VIC 3004",
"name": "Distribution name 036",
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"budget": null,
"priority": 10
}
Example Response
{
"address": "Melbourne VIC 3004",
"brand_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"budget": null,
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"country": "036",
"created_at": "2023-01-20T06:36:03Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "urn:authenticateit:brand_distribution:83478045-d86c-4f6c-9517-af21dbbef6c3",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Distribution name 036",
"notes": "Some text notes",
"participant_id": "urn:authenticateit:participant:708023102856412",
"portfolio": null,
"status": "approved",
"updated_at": "2023-01-20T06:36:03Z",
"priority": 10
}
Read Distribution
GET /participant-service/v2/brands/distributions
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: Distribution id |
Example Response
{
"address": "Melbourne VIC 3004",
"brand_id": "urn:authenticateit:brand:b37e0614-18d7-4c9a-99d6-dfa2c94979ad",
"country": "036",
"created_at": "2022-07-01T08:50:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "urn:authenticateit:brand_distribution:fa91c64b-01f9-42cd-9e9c-670674c63bc6",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Distribution name 036",
"notes": "Some text notes",
"participant_id": "urn:authenticateit:participant:708023102856412",
"status": "approved",
"attachments": [
"urn:epc:id:gdti:0000.00000005.004819191780015"
],
"updated_at": "2022-07-01T08:50:43Z",
"budget": null,
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"priority": 10
}
Delete Distribution
DELETE /participant-service/v2/brands/distributions
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: Distribution id |
Update Distribution
PUT /participant-service/v2/brands/distributions
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: Distribution id |
status |
body | Required for pending records only. approved or rejected |
brand_id |
body | Brand id |
country |
body | Country code |
participant_id |
body | null or valid participant id |
budget |
body | null or non_neg_int |
name |
body | Distribution name {maxlen, 100} |
link |
body | null or url |
notes |
body | null or text {maxlen, 255} |
logo |
body | null or URL |
company_id |
body | Valid company_id |
priority |
body | Int priority |
System can change all editable distribution fields.
Distribution participant can edit only approved
distributions. Fields allowed: notes
, logo
, address
, name
, budget
, priority
Example Request
{
"id":"urn:authenticateit:brand_distribution:fa91c64b-01f9-42cd-9e9c-670674c63bc6",
"country": "036",
"brand_id": "urn:authenticateit:brand:b37e0614-18d7-4c9a-99d6-dfa2c94979ad",
"notes": "Bla bla notes",
"participant_id": "urn:authenticateit:participant:708023102856412",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"address": "Melbourne VIC 3004",
"name": "Distribution name 036",
"budget": 10000,
"company_id": null,
"priority": 10
}
Example Response
{
"address": "Melbourne VIC 3004",
"brand_id": "urn:authenticateit:brand:b37e0614-18d7-4c9a-99d6-dfa2c94979ad",
"country": "036",
"created_at": "2022-07-01T08:50:43Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "urn:authenticateit:brand_distribution:fa91c64b-01f9-42cd-9e9c-670674c63bc6",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Distribution name 036",
"attachments": [
"urn:epc:id:gdti:0000.00000005.004819191780015"
],
"notes": "Bla bla notes",
"participant_id": "urn:authenticateit:participant:708023102856412",
"status": "approved",
"updated_at": "2022-07-01T09:05:34Z",
"budget": 10000,
"company_id": null,
"priority": 10
}
Read Distributions List
POST /participant-service/v2/brands/distributions/list
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
participant_id |
body | For system only filter. Participant id filter |
brand_id |
body | Brand id filter |
country |
body | List of country codes |
status |
body | List of "approved"/"rejected"/"pending" statuses |
name |
body | Distribution name substring (length from 0 to 100) |
created_at_from |
body | Datetime filter |
created_at_to |
body | Datetime filter |
limit |
body | Limit (from 0 to 100) |
offset |
body | Offset (from 0) |
order_type |
body | Order type (asc or desc ) |
order_by |
body | Order parameter |
order_by
may be one of fields: id
,brand_id
,country
,status
,participant_id
,created_at
,updated_at
,name
Example Request
{
"country": ["643", "036"],
"status": ["approved", "pending", "rejected"],
"participant_id": "urn:authenticateit:participant:708023102856412",
"name": "Distribution",
"created_at_from": "2022-01-01T01:01:01Z",
"created_at_to": "2022-09-01T01:01:01Z",
"order_type": "desc",
"order_by": "updated_at",
"limit": 1,
"offset": 0
}
Example Response
{
"count": 11,
"data": [
{
"address": "Melbourne VIC 3004",
"brand_alias": "next1_brand",
"brand_id": "urn:authenticateit:brand:ec373485-0dc1-45df-8c50-9567400c87aa",
"brand_name": "Next1 brand",
"country": "643",
"budget": null,
"attachments": [
"urn:epc:id:gdti:0000.00000005.004819191780015"
],
"created_at": "2022-07-05T08:05:51Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"id": "urn:authenticateit:brand_distribution:b03d5ec9-30a5-4848-97f6-a2140c72060b",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Distribution name 643",
"notes": "For test only. Register please",
"participant_id": "urn:authenticateit:participant:708023102856412",
"status": "approved",
"updated_at": "2022-07-05T08:05:51Z",
"company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2"
}
]
}
Companies management
Company is some option for brands aggregation.
Methods available for system only.
Create Company
POST /participant-service/v2/brands/companies
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
name |
body | Required: Company name {maxlen, 100} |
description |
body | Company description null or text {maxlen, 255} |
country |
body | null or Country code |
phone |
body | null or text {maxlen, 100} |
address |
body | null or text {maxlen, 255} |
email |
body | null or text {maxlen, 100} |
logo |
body | null or URL |
website |
body | null or URL |
brands |
body | List of brand_id |
parent_company_id |
body | Valid company id |
registration_number |
body | null or text {maxlen, 100} |
Example Request
{
"country": "036",
"brands": [
"urn:authenticateit:brand:5dc7f5f7-eeb3-4d32-8c7f-715c38f967bd"
],
"description": "Bla bla notes",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"address": "Melbourne VIC 3004",
"email": "foo@bar.com",
"phone": "+99991231231",
"name": "Company name 036",
"registration_number":"11111",
"parent_company_id": "urn:authenticateit:brand_company:d4573e40-563d-43f1-a1e3-cca0d6456c24"
}
Example Response
{
"address": "Melbourne VIC 3004",
"brands": [
"urn:authenticateit:brand:5dc7f5f7-eeb3-4d32-8c7f-715c38f967bd"
],
"country": "036",
"created_at": "2023-01-25T06:57:03Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Bla bla notes",
"email": "foo@bar.com",
"id": "urn:authenticateit:brand_company:3d45df4e-e037-4f41-9d57-ecedb8e0ec6c",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Company name 036",
"owner": "urn:authenticateit:participant:1",
"parent_company_id": "urn:authenticateit:brand_company:e8cd09eb-9819-4c8b-800a-c3feb53ad443",
"phone": "+99991231231",
"registration_number": "11111",
"updated_at": "2023-01-25T06:57:03Z"
}
Read Company
GET /participant-service/v2/brands/companies
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: Company id |
Example Response
{
"address": "Melbourne VIC 3004",
"brands": [
"urn:authenticateit:brand:5dc7f5f7-eeb3-4d32-8c7f-715c38f967bd"
],
"country": "036",
"created_at": "2023-01-25T06:57:03Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Bla bla notes",
"email": "foo@bar.com",
"id": "urn:authenticateit:brand_company:3d45df4e-e037-4f41-9d57-ecedb8e0ec6c",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Company name 036",
"owner": "urn:authenticateit:participant:1",
"parent_company_id": "urn:authenticateit:brand_company:e8cd09eb-9819-4c8b-800a-c3feb53ad443",
"phone": "+99991231231",
"registration_number": "11111",
"updated_at": "2023-01-25T06:57:03Z"
}
Delete Company
DELETE /participant-service/v2/brands/companies
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: Company id |
Update Company
PUT /participant-service/v2/brands/companies
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
name |
body | Company name {maxlen, 100} |
description |
body | Company description null or text {maxlen, 255} |
country |
body | null or Country code |
phone |
body | null or text {maxlen, 100} |
address |
body | null or text {maxlen, 255} |
email |
body | null or text {maxlen, 100} |
logo |
body | null or URL |
website |
body | null or URL |
brands |
body | List of brand_id |
parent_company_id |
body | Valid company id |
registration_number |
body | null or text {maxlen, 100} |
Example Request
{
"country": "036",
"brands": [
"urn:authenticateit:brand:5dc7f5f7-eeb3-4d32-8c7f-715c38f967bd"
],
"description": "Bla bla notes example",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"address": "Melbourne VIC 3004",
"email": "foo@bar.com",
"id": "urn:authenticateit:brand_company:12e2012f-2c15-4b3f-b1f5-512092323cd1",
"phone": "+99991231231",
"name": "Company name 036"
}
Example Response
{
"address": "Melbourne VIC 3004",
"brands": [
"urn:authenticateit:brand:5dc7f5f7-eeb3-4d32-8c7f-715c38f967bd"
],
"country": "036",
"created_at": "2022-07-04T07:03:02Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Bla bla notes example",
"email": "foo@bar.com",
"id": "urn:authenticateit:brand_company:12e2012f-2c15-4b3f-b1f5-512092323cd1",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Company name 036",
"owner": "urn:authenticateit:participant:1",
"phone": "+99991231231",
"updated_at": "2022-07-04T07:05:48Z"
}
Read Companies List
POST /participant-service/v2/brands/companies/list
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
type |
body | List of "data"/"count" request types |
has_trademarks |
body | Has trademarks filter. True/False/NULL |
country |
body | List of country codes |
phone |
body | Phone substring (length from 0 to 100) |
name |
body | Name substring (length from 0 to 100) |
created_at_from |
body | Datetime filter |
created_at_to |
body | Datetime filter |
limit |
body | Limit (from 0 to 100) |
offset |
body | Offset (from 0) |
order_type |
body | Order type (asc or desc ) |
order_by |
body | One of field (id ,name ,phone ,country ,created_at ,updated_at ) |
Example Request
{
"type": ["data", "count"],
"country": [
"643",
"036"
],
"phone": "99",
"name": "0136",
"has_trademarks":true,
"created_at_from": "2022-01-04T06:16:53Z",
"created_at_to": "2022-09-04T06:16:53Z",
"order_by": "updated_at",
"order_type": "asc",
"limit": 100,
"offset": 0
}
,
Example Response
{
"count": 1,
"data": [
{
"address": "Melbourne VIC 3002",
"brands": [
"urn:authenticateit:brand:000033a9-c82d-4003-b4ac-b7830e3bdd80",
"urn:authenticateit:brand:5d82c008-c0a2-4481-96b2-61d595635d43"
],
"country": "036",
"created_at": "2022-07-04T06:16:53Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "Bla bla notes 123123",
"email": "1foo@bar.com",
"has_trademarks": true,
"id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"name": "Company name 0136",
"owner": "urn:authenticateit:participant:1",
"phone": "+99991231231",
"updated_at": "2022-07-04T06:35:32Z"
},
]
}
Brands global list
Participant has access to the records with they own distributions.
Get joined list
POST /participant-service/v2/brands/global/list
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
type |
body | List of "data"/"count" request types |
product_brands_class_ids |
body | Class id filter |
product_brands_kind |
body | Kind filter |
product_brands_distribution_id |
body | Distribution id filter |
product_brands_distribution_participant_name |
body | Distribution participant name substring |
product_brands_id |
body | Brand id filter |
search |
body | FULLTEXT search by name or registration_number |
product_brands_name |
body | Brand name substring |
product_brands_companies_id |
body | Company id filter |
product_brands_companies_name |
body | Company name substring |
product_brands_companies_country |
body | List of country codes |
product_brands_distribution_country |
body | List of country codes |
product_brands_distribution_status |
body | List of "approved"/"rejected"/"pending" statuses |
product_brands_companies_parent_company_id |
body | List of parent companies |
product_brands_companies_registration_number |
body | List with registration_numbers of companies |
product_brands_ts_renewal_due_from |
body | Datetime |
product_brands_ts_renewal_due_to |
body | Datetime |
product_brands_ts_filling_from |
body | Datetime |
product_brands_ts_filling_to |
body | Datetime |
product_brands_ts_registered_from_from |
body | Datetime |
product_brands_ts_registered_from_to |
body | Datetime |
product_brands_deleted_flag |
body | Boolean |
product_brands_registration_number |
body | Barand registration_numbers (int or text) |
product_brands_registration_country |
body | List of country codes |
limit |
body | Limit (from 0 to 1000) |
offset |
body | Offset (from 0) |
order_type |
body | Order type (asc or desc ) |
order_by |
body | Order parameter |
order_by
may be one of fields:product_brands_class_ids
,
product_brands_kind
,
product_brands_distribution_companies_id
,
product_brands_distribution_id
,product_brands_website
,product_brands_link
,product_brands_distribution_brand_brand_id
,product_brands_distribution_brand_alias
,product_brands_distribution_brand_name
,product_brands_distribution_country
,product_brands_distribution_status
,product_brands_distribution_participant_id
,product_brands_distribution_created_at
,product_brands_distribution_updated_at
,product_brands_distribution_logo
,product_brands_distribution_name
,product_brands_distribution_created_by
,product_brands_distribution_budget
,product_brands_distribution_portfolio
,product_brands_id
,product_brands_company_id
,product_brands_logo
,product_brands_alias
,product_brands_name
,product_brands_owner
,product_brands_registration_number
,product_brands_registration_country
,product_brands_approved
,product_brands_created_at
,product_brands_created_by
,product_brands_updated_at
,product_brands_deleted_at
,product_brands_deleted_flag
,product_brands_companies_id
,product_brands_companies_name
,product_brands_companies_phone
,product_brands_companies_country
,product_brands_companies_owner
,product_brands_companies_logo
,product_brands_companies_created_at
,product_brands_companies_created_by
,product_brands_companies_updated_at
,product_brands_companies_parent_company_id
,product_brands_companies_registration_number
,product_brands_distribution_participant_name
Example Request
{
"type":["count", "data"],
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_distribution_participant_name": "wild",
"product_brands_id": "urn:authenticateit:brand:a22ee70f-2dc6-4f37-8472-3b3bf3f40d02",
"product_brands_name": "brand",
"product_brands_companies_id": "urn:authenticateit:brand_company:e9f277e2-750a-414c-acfd-2810914580a7",
"product_brands_distribution_id": ["urn:authenticateit:brand_distribution:4dfab1f7-23ac-4706-9b71-89d03a2d3c01"],
"product_brands_companies_name": "Company",
"product_brands_companies_country": [
"036"
],
"product_brands_distribution_country": [
"036"
],
"product_brands_distribution_status": [
"approved",
"rejected"
],
"order_by": "product_brands_companies_created_by",
"order_type": "asc",
"limit": 200,
"offset": 0
}
Example Response
{
"count": 2,
"data": [
{
"product_brands_products_num": 0,
"product_brands_created_at": "2023-01-20T06:34:15Z",
"product_brands_companies_updated_at": "2022-07-04T06:35:32Z",
"product_brands_distribution_brand_alias": null,
"product_brands_companies_owner": "urn:authenticateit:participant:1",
"product_brands_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_companies_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_distribution_company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"product_brands_distribution_company_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"product_brands_distribution_id": "urn:authenticateit:brand_distribution:83478045-d86c-4f6c-9517-af21dbbef6c3",
"product_brands_distribution_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_company_registration_number": null,
"product_brands_distribution_country": "036",
"product_brands_distribution_brand_name": null,
"product_brands_website": "https://shping.com",
"product_brands_source_image": "https://cdn2.search.ipaustralia.gov.au/392/TRADE_MARK/T21346271/1.0/T21346271.MEDIUM.JPG",
"product_brands_distribution_updated_at": "2023-01-20T06:36:03Z",
"product_brands_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_company_parent_company_id": null,
"product_brands_distribution_portfolio_name": null,
"product_brands_companies_created_at": "2022-07-04T06:16:53Z",
"product_brands_ts_filling": "2022-10-10T00:00:00Z",
"product_brands_distribution_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_owner": "urn:authenticateit:participant:1",
"product_brands_distribution_created_at": "2023-01-20T06:36:03Z",
"product_brands_updated_at": "2023-01-20T06:34:15Z",
"product_brands_ts_registered_from": "2022-10-10T00:00:00Z",
"product_brands_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"product_brands_status": "Registered/protected",
"product_brands_distribution_budget": null,
"product_brands_companies_parent_company_id": null,
"product_brands_companies_country": "036",
"product_brands_distribution_company_phone": "+99991231231",
"product_brands_registration_country": "036",
"product_brands_kind": "Figurative",
"product_brands_distribution_portfolio": null,
"product_brands_link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"product_brands_registration_number": "2290762222",
"product_brands_deleted_at": null,
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_companies_registration_number": null,
"product_brands_alias": "036-2290762222",
"product_brands_distribution_name": "Distribution name 036",
"product_brands_distribution_company_country": "036",
"product_brands_companies_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"product_brands_deleted_flag": null,
"product_brands_distribution_brand_brand_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"product_brands_name": "Name",
"product_brands_distribution_company_name": "Company name 0136",
"product_brands_companies_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_approved": 1,
"product_brands_companies_name": "Company name 0136",
"product_brands_distribution_participant_name": "Wild Co",
"product_brands_companies_phone": "+99991231231",
"product_brands_class_ids": "30",
"product_brands_ts_renewal_due": "2022-10-10T00:00:00Z",
"product_brands_distribution_company_owner": "urn:authenticateit:participant:1",
"product_brands_distribution_status": "approved"
},
{
"product_brands_products_num": 0,
"product_brands_created_at": "2023-01-20T06:34:15Z",
"product_brands_companies_updated_at": "2022-07-04T06:35:32Z",
"product_brands_distribution_brand_alias": null,
"product_brands_companies_owner": "urn:authenticateit:participant:1",
"product_brands_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_companies_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_distribution_company_id": null,
"product_brands_distribution_company_logo": null,
"product_brands_company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"product_brands_distribution_id": "urn:authenticateit:brand_distribution:f085ae1f-eafe-47a2-909b-ea21e8fb96ba",
"product_brands_distribution_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_company_registration_number": null,
"product_brands_distribution_country": "643",
"product_brands_distribution_brand_name": null,
"product_brands_website": "https://shping.com",
"product_brands_source_image": "https://cdn2.search.ipaustralia.gov.au/392/TRADE_MARK/T21346271/1.0/T21346271.MEDIUM.JPG",
"product_brands_distribution_updated_at": "2023-01-20T06:36:42Z",
"product_brands_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_company_parent_company_id": null,
"product_brands_distribution_portfolio_name": null,
"product_brands_companies_created_at": "2022-07-04T06:16:53Z",
"product_brands_ts_filling": "2022-10-10T00:00:00Z",
"product_brands_distribution_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_owner": "urn:authenticateit:participant:1",
"product_brands_distribution_created_at": "2023-01-20T06:36:42Z",
"product_brands_updated_at": "2023-01-20T06:34:15Z",
"product_brands_ts_registered_from": "2022-10-10T00:00:00Z",
"product_brands_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"product_brands_status": "Registered/protected",
"product_brands_distribution_budget": null,
"product_brands_companies_parent_company_id": null,
"product_brands_companies_country": "036",
"product_brands_distribution_company_phone": null,
"product_brands_registration_country": "036",
"product_brands_kind": "Figurative",
"product_brands_distribution_portfolio": null,
"product_brands_link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"product_brands_registration_number": "2290762222",
"product_brands_deleted_at": null,
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_companies_registration_number": null,
"product_brands_alias": "036-2290762222",
"product_brands_distribution_name": "Distribution name 036",
"product_brands_distribution_company_country": null,
"product_brands_companies_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"product_brands_deleted_flag": null,
"product_brands_distribution_brand_brand_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"product_brands_name": "Name",
"product_brands_distribution_company_name": null,
"product_brands_companies_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_approved": 1,
"product_brands_companies_name": "Company name 0136",
"product_brands_distribution_participant_name": "Wild Co",
"product_brands_companies_phone": "+99991231231",
"product_brands_class_ids": "30",
"product_brands_ts_renewal_due": "2022-10-10T00:00:00Z",
"product_brands_distribution_company_owner": null,
"product_brands_distribution_status": "approved"
},
{
"product_brands_products_num": 3,
"product_brands_created_at": "2022-10-04T05:13:42Z",
"product_brands_companies_updated_at": "2022-07-21T00:58:51Z",
"product_brands_distribution_brand_alias": null,
"product_brands_companies_owner": "urn:authenticateit:participant:1",
"product_brands_logo": null,
"product_brands_companies_logo": "https://dev-cdn.shping.com/2022/7/21/d0399a8e-f787-4ac0-b68f-d3e599004663.jpg",
"product_brands_distribution_company_id": null,
"product_brands_distribution_company_logo": null,
"product_brands_company_id": "urn:authenticateit:brand_company:1b7d9a26-8347-47c3-98e6-a5593d32f318",
"product_brands_distribution_id": "urn:authenticateit:brand_distribution:59e8bba3-c24b-42b5-8317-3e5a1d5b61f0",
"product_brands_distribution_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_company_registration_number": null,
"product_brands_distribution_country": "036",
"product_brands_distribution_brand_name": null,
"product_brands_website": null,
"product_brands_source_image": null,
"product_brands_distribution_updated_at": "2022-11-15T02:55:39Z",
"product_brands_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_company_parent_company_id": null,
"product_brands_distribution_portfolio_name": null,
"product_brands_companies_created_at": "2022-07-21T00:58:51Z",
"product_brands_ts_filling": null,
"product_brands_distribution_logo": null,
"product_brands_owner": "urn:authenticateit:participant:1",
"product_brands_distribution_created_at": "2022-10-04T05:23:42Z",
"product_brands_updated_at": "2022-10-04T05:13:42Z",
"product_brands_ts_registered_from": null,
"product_brands_id": "urn:authenticateit:brand:de89dfbd-d899-4af9-ae8f-35e53dd65807",
"product_brands_status": null,
"product_brands_distribution_budget": 10000,
"product_brands_companies_parent_company_id": null,
"product_brands_companies_country": "036",
"product_brands_distribution_company_phone": null,
"product_brands_registration_country": "036",
"product_brands_kind": null,
"product_brands_distribution_portfolio": null,
"product_brands_link": null,
"product_brands_registration_number": "31911",
"product_brands_deleted_at": null,
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_companies_registration_number": null,
"product_brands_alias": "036-31911",
"product_brands_distribution_name": "Wild Co Permanent",
"product_brands_distribution_company_country": null,
"product_brands_companies_id": "urn:authenticateit:brand_company:1b7d9a26-8347-47c3-98e6-a5593d32f318",
"product_brands_deleted_flag": null,
"product_brands_distribution_brand_brand_id": "urn:authenticateit:brand:de89dfbd-d899-4af9-ae8f-35e53dd65807",
"product_brands_name": "Permanent",
"product_brands_distribution_company_name": null,
"product_brands_companies_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_approved": 1,
"product_brands_companies_name": "Wings and Horns",
"product_brands_distribution_participant_name": "Wild Co",
"product_brands_companies_phone": "+61435431728",
"product_brands_class_ids": null,
"product_brands_ts_renewal_due": null,
"product_brands_distribution_company_owner": null,
"product_brands_distribution_status": "approved"
}
]
}
Get brands list
POST /participant-service/v2/brands/global/brands/list
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
type |
body | List of "data"/"count" request types |
product_brands_distribution_participant_id |
body | Distribution participant id filter |
product_brands_distribution_id |
body | Distribution id filter |
product_brands_distribution_participant_name |
body | Distribution participant name substring |
product_brands_id |
body | Brand id filter |
product_brands_name |
body | Brand name substring |
product_brands_companies_id |
body | Company id filter |
product_brands_companies_name |
body | Company name substring |
product_brands_companies_country |
body | List of country codes |
product_brands_distribution_country |
body | List of country codes |
product_brands_distribution_status |
body | List of "approved"/"rejected"/"pending" statuses |
order_type |
body | Order type (asc or desc ) |
order_by |
body | Order parameter |
order_by
may be one of fields:product_brands_distribution_id
,product_brands_distribution_brand_brand_id
,product_brands_distribution_brand_alias
,product_brands_distribution_brand_name
,product_brands_distribution_country
,product_brands_distribution_status
,product_brands_distribution_participant_id
,product_brands_distribution_created_at
,product_brands_distribution_updated_at
,product_brands_distribution_logo
,product_brands_distribution_name
,product_brands_distribution_created_by
,product_brands_distribution_budget
,product_brands_distribution_portfolio
,product_brands_id
,product_brands_website
,product_brands_link
,product_brands_company_id
,product_brands_logo
,product_brands_alias
,product_brands_name
,product_brands_owner
,product_brands_approved
,product_brands_created_at
,product_brands_created_by
,product_brands_updated_at
,product_brands_deleted_at
,product_brands_deleted_flag
,product_brands_companies_id
,product_brands_companies_name
,product_brands_companies_phone
,product_brands_companies_country
,product_brands_companies_owner
,product_brands_companies_logo
,product_brands_companies_created_at
,product_brands_companies_created_by
,product_brands_companies_updated_at
,product_brands_distribution_participant_name
Example Request
{
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_distribution_participant_name": "wild",
"product_brands_id": "urn:authenticateit:brand:a22ee70f-2dc6-4f37-8472-3b3bf3f40d02",
"product_brands_name": "brand",
"product_brands_companies_id": "urn:authenticateit:brand_company:e9f277e2-750a-414c-acfd-2810914580a7",
"product_brands_distribution_id": ["urn:authenticateit:brand_distribution:4dfab1f7-23ac-4706-9b71-89d03a2d3c01"],
"product_brands_companies_name": "Company",
"product_brands_companies_country": [
"036"
],
"product_brands_distribution_country": [
"036"
],
"product_brands_distribution_status": [
"approved",
"rejected"
],
"order_by": "product_brands_companies_created_by",
"order_type": "asc"
}
Example Response
{
"count": 2,
"data": [
{
"product_brands_alias": "036-2290762222",
"product_brands_approved": 1,
"product_brands_class_ids": "30",
"product_brands_company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"product_brands_created_at": "2023-01-20T06:34:15Z",
"product_brands_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_deleted_at": null,
"product_brands_deleted_flag": null,
"product_brands_distributions": [
{
"product_brands_distribution_brand_alias": null,
"product_brands_distribution_brand_brand_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"product_brands_distribution_brand_name": null,
"product_brands_distribution_budget": null,
"product_brands_distribution_company_country": null,
"product_brands_distribution_company_id": null,
"product_brands_distribution_company_logo": null,
"product_brands_distribution_company_name": null,
"product_brands_distribution_company_owner": null,
"product_brands_distribution_company_parent_company_id": null,
"product_brands_distribution_company_phone": null,
"product_brands_distribution_company_registration_number": null,
"product_brands_distribution_country": "643",
"product_brands_distribution_created_at": "2023-01-20T06:36:42Z",
"product_brands_distribution_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_id": "urn:authenticateit:brand_distribution:f085ae1f-eafe-47a2-909b-ea21e8fb96ba",
"product_brands_distribution_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_distribution_name": "Distribution name 036",
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_distribution_portfolio": null,
"product_brands_distribution_portfolio_name": null,
"product_brands_distribution_status": "approved",
"product_brands_distribution_updated_at": "2023-01-20T06:36:42Z"
},
{
"product_brands_distribution_brand_alias": null,
"product_brands_distribution_brand_brand_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"product_brands_distribution_brand_name": null,
"product_brands_distribution_budget": null,
"product_brands_distribution_company_country": "036",
"product_brands_distribution_company_id": "urn:authenticateit:brand_company:60da5c0c-1202-49d8-a8e4-735830716ec2",
"product_brands_distribution_company_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_distribution_company_name": "Company name 0136",
"product_brands_distribution_company_owner": "urn:authenticateit:participant:1",
"product_brands_distribution_company_parent_company_id": null,
"product_brands_distribution_company_phone": "+99991231231",
"product_brands_distribution_company_registration_number": null,
"product_brands_distribution_country": "036",
"product_brands_distribution_created_at": "2023-01-20T06:36:03Z",
"product_brands_distribution_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_id": "urn:authenticateit:brand_distribution:83478045-d86c-4f6c-9517-af21dbbef6c3",
"product_brands_distribution_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_distribution_name": "Distribution name 036",
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_distribution_portfolio": null,
"product_brands_distribution_portfolio_name": null,
"product_brands_distribution_status": "approved",
"product_brands_distribution_updated_at": "2023-01-20T06:36:03Z"
}
],
"product_brands_id": "urn:authenticateit:brand:6ca16ebd-f39b-4599-8804-a8946049f765",
"product_brands_kind": "Figurative",
"product_brands_link": "https://cdn.shping.com/2022/7/1/10ec9c47-e719-4651-b919-c2941e0e25b7.png",
"product_brands_logo": "https://cdn.shping.com/2022/7/1/8b80bbb7-9e92-491a-9a66-c2de432162ef.png",
"product_brands_name": "Name",
"product_brands_owner": "urn:authenticateit:participant:1",
"product_brands_products_num": 0,
"product_brands_registration_country": "036",
"product_brands_registration_number": "2290762222",
"product_brands_status": "Registered/protected",
"product_brands_ts_filling": "2022-10-10T00:00:00Z",
"product_brands_ts_registered_from": "2022-10-10T00:00:00Z",
"product_brands_ts_renewal_due": "2022-10-10T00:00:00Z",
"product_brands_updated_at": "2023-01-20T06:34:15Z",
"product_brands_website": "https://shping.com"
},
{
"product_brands_alias": "036-31911",
"product_brands_approved": 1,
"product_brands_class_ids": null,
"product_brands_company_id": "urn:authenticateit:brand_company:1b7d9a26-8347-47c3-98e6-a5593d32f318",
"product_brands_created_at": "2022-10-04T05:13:42Z",
"product_brands_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_deleted_at": null,
"product_brands_deleted_flag": null,
"product_brands_distributions": [
{
"product_brands_distribution_brand_alias": null,
"product_brands_distribution_brand_brand_id": "urn:authenticateit:brand:de89dfbd-d899-4af9-ae8f-35e53dd65807",
"product_brands_distribution_brand_name": null,
"product_brands_distribution_budget": 10000,
"product_brands_distribution_company_country": null,
"product_brands_distribution_company_id": null,
"product_brands_distribution_company_logo": null,
"product_brands_distribution_company_name": null,
"product_brands_distribution_company_owner": null,
"product_brands_distribution_company_parent_company_id": null,
"product_brands_distribution_company_phone": null,
"product_brands_distribution_company_registration_number": null,
"product_brands_distribution_country": "036",
"product_brands_distribution_created_at": "2022-10-04T05:23:42Z",
"product_brands_distribution_created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"product_brands_distribution_id": "urn:authenticateit:brand_distribution:59e8bba3-c24b-42b5-8317-3e5a1d5b61f0",
"product_brands_distribution_logo": null,
"product_brands_distribution_name": "Wild Co Permanent",
"product_brands_distribution_participant_id": "urn:authenticateit:participant:708023102856412",
"product_brands_distribution_portfolio": null,
"product_brands_distribution_portfolio_name": null,
"product_brands_distribution_status": "approved",
"product_brands_distribution_updated_at": "2022-11-15T02:55:39Z"
}
],
"product_brands_id": "urn:authenticateit:brand:de89dfbd-d899-4af9-ae8f-35e53dd65807",
"product_brands_kind": null,
"product_brands_link": null,
"product_brands_logo": null,
"product_brands_name": "Permanent",
"product_brands_owner": "urn:authenticateit:participant:1",
"product_brands_products_num": 3,
"product_brands_registration_country": "036",
"product_brands_registration_number": "31911",
"product_brands_status": null,
"product_brands_ts_filling": null,
"product_brands_ts_registered_from": null,
"product_brands_ts_renewal_due": null,
"product_brands_updated_at": "2022-10-04T05:13:42Z",
"product_brands_website": null
}
]
}
Get partner brands list
GET /participant-service/v2/brands/list/partners
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
page |
body | Page token |
Example Response
{
"list": [
{
"brand_id": "urn:authenticateit:brand:aa441cb4-ffb6-471a-9b42-9b35ad715455",
"brand_logo": null,
"brand_name": "SURF RESCUE",
"distribution_created_at": "2023-08-09T09:03:29Z",
"distribution_id": "urn:authenticateit:brand_distribution:1aa0c2a6-ba8b-4e96-adb8-dd7929d20724",
"distribution_priority": 100
},
{
"brand_id": "some_brand_id",
"brand_logo": "https://dev-cdn.shping.com/2023/7/20/63a3db1a-6ecf-4ac9-8a2a-636c27888d1b.jpg",
"brand_name": "Ethertest",
"distribution_created_at": "2022-07-12T04:16:41Z",
"distribution_id": "urn:authenticateit:brand_distribution:105cf454-2c3b-480e-b221-518ac8ae9efd",
"distribution_priority": 19
}
],
"next_page": "brand_partners:4c880bd6-5944-4b06-a83d-fbdbe89eb86a"
}
Distribution Attachments
Attach GDTIs to Distribution
Link approved Distribution to existing GDTI documents. Request body must have
Distribution id
and attachments
list of document identifiers . Responds
with updated attachments
list of the Distribution.
Distribution attachment positions may be overriden with
attachment_positions
in the request body. See product
attachments API description for more
information on attachment positions.
POST /participant-service/v2/brands/distributions/attachments/add
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"id": "urn:authenticateit:brand_distribution:7e737d5e-54e4-4d51-bbdc-dfd15355d2d7",
"attachments": [
"urn:epc:id:gdti:0000.00000005.004803474973806",
"urn:epc:id:gdti:0000.00000005.004819191780015"
],
"attachment_positions": {
"urn:epc:id:gdti:0000.00000005.004803474973806": 1,
"urn:epc:id:gdti:0000.00000005.004819191780015": null
}
}
Example Response
[
"urn:epc:id:gdti:0000.00000005.004803474973806",
"urn:epc:id:gdti:0000.00000005.004819191780015"
]
Detach GDTIs from Distribution
Unlink Distribution from GDTI documents. Request body must have Distribution id
and attachments
list of document identifiers to be
detached. Responds with updated attachments
list of the Distribution.
Attachment positions for the detached GDTIs will also be removed.
Positions for selected brand attachments may be removed by providing
attachment_positions
in the request body. See product
attachments API description for more
information.
POST /participant-service/v2/brands/distributions/attachments/remove
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Request
{
"id": "urn:authenticateit:brand_distribution:7e737d5e-54e4-4d51-bbdc-dfd15355d2d7",
"attachments": [
"urn:epc:id:gdti:0000.00000005.004819191780015"
],
"attachment_positions": {
"urn:epc:id:gdti:0000.00000005.004803474973806": null
}
}
Example Response
[
"urn:epc:id:gdti:0000.00000005.004803474973806"
]
Loyalty program management
Methods available only for system. Participant must contain retail_connect
module
Get Loyalty Program
GET /participant-service/loyalty_program/:participant_id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
participant_id |
url | Required: Participant id |
Example Response. Default loyalty program
{
"bgcolor": "#270404",
"country": "036",
"description": "Base loyalty program description",
"image_big": "https://cdn.shping.com/2023/3/24/4cc16f3e-5410-4829-9e91-d063270b1147.png",
"image_small": "https://cdn.shping.com/2023/3/24/4cc16f3e-5410-4829-9e91-d063270b1147.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"type": "purchases_count",
"value": 5
},
{
"type": "spends",
"value": 5
}
]
},
{
"level_id": "vip",
"rules": [
{
"type": "purchases_count",
"value": 10
},
{
"type": "spends",
"value": 10
}
]
}
],
"levels": [
"casual",
"regular",
"vip"
],
"name": "Base loyalty program",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 10
},
{
"level_id": "regular",
"rebate_percents": 15
},
{
"level_id": "vip",
"rebate_percents": 20
}
],
"type": "default"
}
Example Response. Custom loyalty program
{
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 2000,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-06-01T01:56:46Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "The loyalty card list will be updated to include the <b>NovaStore</b> card, which enables payment with shping coins and offers a personalized discount of up to 33% at affiliated stores.",
"id": "77d750be-0b07-4438-a291-71ea355f93d4",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"type": "purchases_count",
"value": 11
},
{
"type": "spends",
"value": 2000
}
]
},
{
"level_id": "vip",
"rules": [
{
"type": "purchases_count",
"value": 22
},
{
"type": "spends",
"value": 2500
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom"
}
Set/Update Custom Loyalty Program
POST /participant-service/loyalty_program/:participant_id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
participant_id |
url | Required: Participant id |
name |
string | Required: Name |
description |
string | Required: Description |
country |
string | Required: Country code |
bgcolor |
string | Required: Colour code |
image_big |
url | Required: Image url |
image_small |
url | Required: Image small |
rebate |
list | Required: Rebate rules |
level_up |
list | Required: Level up rules |
coin_payments_rule |
object | Coin payment limit rule |
Coin payment limit rule. Limit by coins. No more than 100 COINS per transfer
{
...
"coin_payments_rule": {
"type": "coins",
"coins": "100000000000000000000"
},
...
}
Coin payment limit rule. Limit by percents. No more than 10% of amount per transfer
{
...
"coin_payments_rule": {
"type": "percents",
"percents": 10
},
...
}
Coin payment limit rule. Limit by currency_value. No more than 200 Cents ($2) per transfer
{
...
"coin_payments_rule": {
"type": "currency_value",
"currency_value": 200
},
...
}
Example Request
{
"coin_payments_rule": {
"type": "currency_value",
"currency_value": 2000
},
"country": "036",
"bgcolor": "#ED1010",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"description": "The loyalty card list will be updated to include the <b>NovaStore</b> card, which enables payment with shping coins and offers a personalized discount of up to 33% at affiliated stores.",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"value": 11,
"type": "purchases_count"
},
{
"value": 2000,
"type": "spends"
}
]
},
{
"level_id": "vip",
"rules": [
{
"value": 22,
"type": "purchases_count"
},
{
"value": 2500,
"type": "spends"
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
]
}
Example Response
{
"bgcolor": "#ED1010",
"coin_payments_rule": {
"currency_value": 2000,
"type": "currency_value"
},
"country": "036",
"created_at": "2023-06-01T01:56:46Z",
"created_by": "urn:authenticateit:user:email:system@authenticateit.com",
"description": "The loyalty card list will be updated to include the <b>NovaStore</b> card, which enables payment with shping coins and offers a personalized discount of up to 33% at affiliated stores.",
"id": "77d750be-0b07-4438-a291-71ea355f93d4",
"image_big": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"image_small": "https://dev-cdn.shping.com/2023/3/31/8ae6d806-d44a-4c0e-beb8-6a24187249e4.png",
"level_up": [
{
"level_id": "casual",
"rules": []
},
{
"level_id": "regular",
"rules": [
{
"type": "purchases_count",
"value": 11
},
{
"type": "spends",
"value": 2000
}
]
},
{
"level_id": "vip",
"rules": [
{
"type": "purchases_count",
"value": 22
},
{
"type": "spends",
"value": 2500
}
]
}
],
"name": "NovaStore",
"rebate": [
{
"level_id": "casual",
"rebate_percents": 15
},
{
"level_id": "regular",
"rebate_percents": 25
},
{
"level_id": "vip",
"rebate_percents": 33
}
],
"type": "custom"
}
Remove Custom Loyalty Program
DELETE /participant-service/loyalty_program/:participant_id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
participant_id |
url | Required: Participant id |
Get Loyalty Program's Deeplink
GET /participant-service/retail_connect/deeplink/:participant_id
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
participant_id |
url | Required: Participant id |
Example Response
{
"deeplink_url": "https://test-shping.app.link/TS2csjNRGyb",
"type": "stored",
"url": "https://dev-www.shping.com/mobile/invite.html?page=storecards&action=add_retail_connect_storecard&code=735879621218609"
}
Terminals management
Methods allow users with the role retail_connect_admin
to connect/disconnect/read/update and read code status of terminal devices
Get pair code
GET /participant-service/terminals/code
retail_connect_admin
role reqired
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
type |
body | Required: Code format (uuid /int ) |
Example Response. int
{
"code": "4899",
"expiration_sec": 120,
"expiration_ts": "2023-03-16T02:58:23Z",
"generate_ts": "2023-03-16T02:56:23Z"
}
Example Response. uuid
{
"code": "8ade5a79-b64e-4865-b817-534822d5723f",
"expiration_sec": 120,
"expiration_ts": "2023-03-16T02:58:53Z",
"generate_ts": "2023-03-16T02:56:53Z"
}
Get pair code status
GET /participant-service/terminals/code/status
retail_connect_admin
role reqired
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
code |
body | Required: Code |
Example Response
{
"status": "failure"
}
Example Response
{
"status": "pending"
}
Example Response
{
"status": "success"
}
Pair device
POST /participant-service/terminals/devices
Parameters
Name | Type | Description |
---|---|---|
code |
body | Required: Code |
meta |
body | Meta data |
Example Request
{
"code": "7369",
"meta": {
"vendor_id": "111111"
}
}
Example Response
{
"id": "735879621218609:da980f51-f26f-480e-a1c9-06033ddd3ca6",
"meta": {
"vendor_id": "111111"
},
"ts": "2023-03-17T08:18:11Z"
}
Update device
PUT /participant-service/terminals/devices
retail_connect_admin
role reqired
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: Device id |
name |
body | Optional name |
Example Request
{
"id": "735879621218609:da980f51-f26f-480e-a1c9-06033ddd3ca6",
"name": "Dan's device"
}
Example Response
{
"id": "735879621218609:da980f51-f26f-480e-a1c9-06033ddd3ca6",
"meta": {
"vendor_id": "111111"
},
"name": "Dan's device",
"ts": "2023-03-17T08:18:11Z"
}
Read devices
GET /participant-service/terminals/devices
retail_connect_admin
role reqired
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
Example Response
{
"list": [
{
"id": "735879621218609:cb103bee-46a5-4686-a1a7-fb76b2d78a0a",
"meta": {
"vendor_id": "222222"
},
"name": "Mary's device",
"ts": "2023-03-17T08:20:02Z"
},
{
"id": "735879621218609:da980f51-f26f-480e-a1c9-06033ddd3ca6",
"meta": {
"vendor_id": "111111"
},
"name": "Dan's device",
"ts": "2023-03-17T08:18:11Z"
}
]
}
Remove devices
DELETE /participant-service/terminals/devices?id=
retail_connect_admin
role reqired
Parameters
Name | Type | Description |
---|---|---|
authenticateit_identity_ticket |
header | Required: Session's ticket |
id |
body | Required: Device id |
Read terminal team
GET /participant-service/terminals/team
Parameters
Name | Type | Description |
---|---|---|
authenticateit_terminal_device |
header | Required: Device ticket |
Team members may have different authentication mechanisms depending on service
value.
1) email
- allows creating session using email
(for user urn:authenticateit:user:email:shping:9cf92a52-e708-4d45-a7f5-53ed475c1c3c
)
2) nickname
- allows creating session using nickname
(for user urn:authenticateit:user:nickname:shping:19ead23d-8979-4b7f-b81f-1ee56b06b1d2
)
nickname_participant
value should be used as participant
for creating a session.
Example Response
{
"list": [
{
"access_type": "Admin",
"email": "ikleeen+811@gmail.com",
"first_name": "Test name",
"id": "urn:authenticateit:user:email:shping:9cf92a52-e708-4d45-a7f5-53ed475c1c3c",
"last_access": null,
"last_name": "Test name",
"participants": [
{
"id": "urn:authenticateit:participant:32637638310736",
"name": "Test participant",
"roles": [
"payments_admin",
"product_line",
"security_admin"
]
},
{
"id": "urn:authenticateit:participant:735879621218609",
"name": "Main",
"roles": [
"payments_admin",
"product_line",
"report_viewer",
"retail_connect_admin",
"retail_connect_operator",
"reviews_admin",
"rewards_admin",
"security_admin",
"serialization_admin",
"serialization_viewer",
"supply_chain",
"supply_chain_admin",
"todo_cards_supervisor"
]
}
],
"photo": "https://dev-cdn.shping.com/2022/11/9/0581b6f9-79a1-4096-9611-bb88ad31f6af",
"roles": [
"payments_admin",
"product_line",
"report_viewer",
"retail_connect_admin",
"retail_connect_operator",
"reviews_admin",
"rewards_admin",
"security_admin",
"serialization_admin",
"serialization_viewer",
"supply_chain",
"supply_chain_admin",
"todo_cards_supervisor"
],
"service": "email",
"service_id": "ikleeen+811@gmail.com",
"ts": "2023-03-09T08:10:29Z"
},
{
"access_type": "RetailConnectOperator",
"first_name": "rtoperator",
"photo": "https://dev-cdn.shping.com/2022/11/9/0581b6f9-79a1-4096-9611-bb88ad31f6af",
"id": "urn:authenticateit:user:nickname:shping:19ead23d-8979-4b7f-b81f-1ee56b06b1d2",
"last_access": null,
"last_name": "Last name",
"participants": [
{
"id": "urn:authenticateit:participant:735879621218609",
"name": "Main",
"roles": [
"product_line",
"retail_connect_operator"
]
}
],
"roles": [
"product_line",
"retail_connect_operator"
],
"service": "nickname",
"nickname": "rtoperator",
"nickname_participant": "735879621218609",
"service_id": "735879621218609:rtoperator",
"ts": "2023-03-14T07:53:10Z"
},
{
"access_type": "Admin",
"first_name": "admin",
"id": "urn:authenticateit:user:nickname:shping:d5c8d565-01d7-4477-9074-a5d02d87e0a5",
"last_access": null,
"last_name": "Last name",
"participants": [
{
"id": "urn:authenticateit:participant:735879621218609",
"name": "Main",
"roles": [
"payments_admin",
"product_line",
"report_viewer",
"retail_connect_admin",
"retail_connect_operator",
"reviews_admin",
"rewards_admin",
"security_admin",
"serialization_admin",
"serialization_viewer",
"supply_chain",
"supply_chain_admin",
"todo_cards_supervisor"
]
}
],
"roles": [
"payments_admin",
"product_line",
"report_viewer",
"retail_connect_admin",
"retail_connect_operator",
"reviews_admin",
"rewards_admin",
"security_admin",
"serialization_admin",
"serialization_viewer",
"supply_chain",
"supply_chain_admin",
"todo_cards_supervisor"
],
"service": "nickname",
"nickname": "admin",
"nickname_participant": "735879621218609",
"service_id": "735879621218609:admin",
"ts": "2023-03-14T06:20:02Z"
}
]
}