Public
Documentation Settings
ce234a
Double Column
cURL - cURL
Gift Wrap
Introduction
GET
Get Categories
GET
Get Category by ID
POST
Save Category
DEL
Delete Category by ID
GET
Get Wrappers
GET
Get Wrapper by ID
POST
Save Wrapper
POST
Set Wrapper for Cart Item
POST
Set Wrapper for All Cart
DEL
Delete Wrapper by ID
DEL
Remove Wrapper from Cart Item
DEL
Remove Wrapper from All Cart
GET
Get Wrapping Orders
GET
Get Wrapping Order by ID
GET
Get Order
GET
Get Order by ID
GET
Get Order Items
GET
Get Order Items by ID

Gift Wrap

GETGet Categories

{{magento_base_url}}/rest/V1/mpGiftWrap/categories
AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Content-Type

application/json

Example Request
GET Categories Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/mpGiftWrap/categories?searchCriteria[filter_groups][0][filters][0][field]=category_id&searchCriteria[filter_groups][0][filters][0][value]=1&searchCriteria[filter_groups][0][filters][0][condition_type]=eq' \
--header 'Content-Type: application/json' \
--data ''
200 OK
Example Response
json
{
  "items": [
    {
      "category_id": "1",
      "name": "Happy Birthday",
      "status": "2",
      "description": null,
      "store_id": "0",
      "customer_group": "0,1,2,3",
      "sort_order": "0",
      "created_at": "2020-02-18 07:39:34",
      "updated_at": "2020-02-18 07:43:34"
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "category_id",
            "value": "1",
            "condition_type": "eq"
          }
        ]
      }
    ]
  },
  "total_count": 1
}
Date

Tue, 18 Feb 2020 08:53:05 GMT

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=2evf15f625aqaega2qqnee0m1c; expires=Tue, 18-Feb-2020 09:53:12 GMT; Max-Age=3600; path=/api/api; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

342

Content-Type

application/json; charset=utf-8

Age

0

X-Cache

MISS

X-Cache-Hits

0

Accept-Ranges

bytes

Connection

keep-alive

GETGet Category by ID

{{magento_base_url}}/rest/V1/mpGiftWrap/categories/:id
AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Content-Type

application/json

PATH VARIABLES
id

1

Example Request
GET Categories ID Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/mpGiftWrap/categories/1' \
--header 'Content-Type: application/json'
200 OK
Example Response
json
{
  "category_id": 1,
  "name": "Happy Birthday",
  "status": 2,
  "description": null,
  "store_id": "0",
  "customer_group": "0,1,2,3",
  "sort_order": 0,
  "created_at": "2020-02-18 07:39:34",
  "updated_at": "2020-02-19 08:16:25"
}
Date

Wed, 19 Feb 2020 08:59:30 GMT

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=dfck0ubi4a4achmp9i17d0dt5n; expires=Wed, 19-Feb-2020 09:59:37 GMT; Max-Age=3600; path=/api/api; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

198

Content-Type

application/json; charset=utf-8

Age

0

X-Cache

MISS

X-Cache-Hits

0

Accept-Ranges

bytes

Connection

keep-alive

POSTSave Category

{{magento_base_url}}/rest/V1/mpGiftWrap/categories
AUTHORIZATIONBearer Token
Token

<token>

HEADERS
Content-Type

application/json

Bodyraw 
{
    "entity": {
        "name": "Happy Birthday",
        "status": "2",
        "description": "abc",
        "store_id": "0",
        "customer_group": "0,1,2,3",
        "sort_order": "0"
    }
}
Example Request
POST Categories Example
curl
curl --location -g '{{magento_base_url}}/rest/V1/mpGiftWrap/categories' \
--header 'Content-Type: application/json' \
--data '{
    "entity": {
        "name": "Happy Birthday",
        "status": "2",
        "description": "abc",
        "store_id": "0",
        "customer_group": "0,1,2,3",
        "sort_order": "0"
    }
}'
200 OK
Example Response
json
{
  "category_id": "7",
  "name": "Happy Birthday",
  "status": "2",
  "description": "abc",
  "store_id": "0",
  "customer_group": "0,1,2,3",
  "sort_order": "0",
  "created_at": "2020-02-18 09:27:18",
  "updated_at": "2020-02-18 09:27:18"
}
Date

Tue, 18 Feb 2020 09:27:11 GMT

Expires

Thu, 19 Nov 1981 08:52:00 GMT

Cache-Control

no-store, no-cache, must-revalidate

Pragma

no-cache

Set-Cookie

PHPSESSID=2evf15f625aqaega2qqnee0m1c; expires=Tue, 18-Feb-2020 10:27:18 GMT; Max-Age=3600; path=/api/api; domain=develop.mageplaza.com; HttpOnly

X-Frame-Options

SAMEORIGIN

Content-Length

205

Content-Type

application/json; charset=utf-8

Age

0

X-Cache

MISS

X-Cache-Hits

0

Accept-Ranges

bytes

Connection

keep-alive