Create marketing expansion

Requires write_marketing_event access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20261201/sales/marketing_activity_extension.json

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Request Headers

Content-Type string required

The field must be set to the fixed value application/json; charset=utf-8.
Authorization string required

The access token for the API resource. Refer to App authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Request Body

marketing_activityobject

Marketing expansion
ended_at string

End time
Example: 2022-12-15T09:00:00+08:00
utm_term string

Signature search keyword
Example: this is utm term name
remote_id string required

unique id for [App] data
Example: 53e7f97e-8df5-4a6b-b672-5cda96b90821
utm_medium string

Source type of logo ( email , article )
Example: email
marketing_activity_id string

Marketing expansion campaign id
Example: MA_6019932248291157288
utm_campaign string

Logo specific advertising
Example: google
utm_content string

Distinguish between different links within the same ad
Example: googleAds
form_data string

Json's form data is serialized as a string
Example: {\"budget\":{\"frequency\":\"DAILY\",\"currency\":\"TWD\"},\"time\":{\"startTime\":1671275280000,\"endTime\":1671361680000}}
marketing_activity_title string

Marketing expansion campaign title
Example: This is marketing activity title
utm_source string

Identity advertising customers , advertising websites
Example: www.shopline.com
started_at string

Start time
Example: 2022-12-15T09:00:00+08:00
marketing_activity_extension_id string required

Marketing expansion id
Example: b1ee529b-d71d-41d6-93ba-ee46986d3a4b
status string required

Current status of marketing campaign , draft
,failed
,active
,inactive
,scheduled
,paused
,deleted_externally
on the outside
Example: draft

Status Codes

For the complete list of codes and messages, see Http status code.

Response Headers

traceId

A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.

Response Body

marketing_activityobject

Marketing expansion
marketing_activity_id string

Marketing expansion campaign id
Example: MA_6019932248291157288
utm_campaign string

Logo specific advertising
Example: google
utm_content string

Distinguish between different links within the same ad
Example: googleAds
ended_at string

End time
Example: 2022-12-15T09:00:00+08:00
started_at string

Start time
Example: 2022-12-15T09:00:00+08:00
utm_term string

Signature search keyword
Example: this is utm term name
utm_source string

Identity advertising customers , advertising websites
Example: www.shopline.com
form_data string

Json's form data is serialized as a string
Example: {\"budget\":{\"frequency\":\"DAILY\",\"currency\":\"TWD\"},\"time\":{\"startTime\":1671275280000,\"endTime\":1671361680000}}
marketing_activity_extension_id string

Marketing expansion id
Example: b1ee529b-d71d-41d6-93ba-ee46986d3a4b
status string

Current status of marketing campaign , draft
,failed
,active
,inactive
,scheduled
,paused
,deleted_externally
on the outside
Example: draft
remote_id string

unique id for [App] data
Example: 53e7f97e-8df5-4a6b-b672-5cda96b90821
utm_medium string

Source type of logo ( email , article )
Example: email
marketing_activity_title string

Marketing expansion campaign title
Example: This is marketing activity title

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201

ParamOptions

Authorization — header required

Body

Body required

{
  "marketing_activity": {
    "utm_term": "this is utm term name",
    "ended_at": "2022-12-15T09:00:00+08:00",
    "status": "draft",
    "utm_campaign": "google",
    "utm_source": "www.shopline.com",
    "started_at": "2022-12-15T09:00:00+08:00",
    "utm_content": "googleAds",
    "marketing_activity_extension_id": "b1ee529b-d71d-41d6-93ba-ee46986d3a4b",
    "marketing_activity_id": "MA_6019932248291157288",
    "form_data": "{\\\"budget\\\":{\\\"frequency\\\":\\\"DAILY\\\",\\\"currency\\\":\\\"TWD\\\"},\\\"time\\\":{\\\"startTime\\\":1671275280000,\\\"endTime\\\":1671361680000}}",
    "utm_medium": "email",
    "remote_id": "53e7f97e-8df5-4a6b-b672-5cda96b90821",
    "marketing_activity_title": "This is marketing activity title"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/sales/marketing_activity_extension.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal