{"_id":"5b8ec6a1f8dd7c0003385fb8","category":{"_id":"5b8ec6a1f8dd7c0003385fa6","version":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-05-12T15:22:00.041Z","from_sync":false,"order":4,"slug":"coupon","title":"Catalog"},"parentDoc":null,"project":"57336fd5a6a9c40e00e13a0b","user":"560d5913af97231900938124","version":{"_id":"5b8ec6a1f8dd7c0003386069","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"5b19742cb3baf90003cab5ae","createdAt":"2018-04-24T15:33:45.744Z","releaseDate":"2018-04-24T15:33:45.744Z","categories":["5b8ec6a1f8dd7c0003385fa2","5b8ec6a1f8dd7c0003385fa3","5b8ec6a1f8dd7c0003385fa4","5b8ec6a1f8dd7c0003385fa5","5b8ec6a1f8dd7c0003385fa6","5b8ec6a1f8dd7c0003385fa7","5b8ec6a1f8dd7c0003385fa8","5b8ec6a1f8dd7c0003385fa9","5b8ec6a1f8dd7c0003385faa","5b8ec6a1f8dd7c0003385fab","5b8ec6a1f8dd7c0003385fac"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.27 Release","version_clean":"8976.0.0-Extended","version":"8976-Extended"},"githubsync":"","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-12T15:07:39.644Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"text","code":""}]},"settings":"","examples":{"codes":[]},"method":"post","auth":"optional","params":[],"url":""},"isReference":true,"order":0,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/catalog/products</span>\n\n<hr>\n\n##Documentation\nThe Create Product request enables you to create a new product in your catalog.\n\n###Request Content\n`product` &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>, contains the following properties (see [product](doc:product)):\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-status` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-name` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-short-description` *string* &nbsp;&nbsp;&nbsp;<span style=\"color:#F37500\">**required**</span>\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-long-description` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-info-url` *decimal* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-image` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-merchant-descriptor` *string* &nbsp;&nbsp;&nbsp;optional\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;`product-support-email` *string* &nbsp;&nbsp;&nbsp;optional\n\n###Response Details\nIf successful, the response HTTP status code is 201 Created.\nThe `product-id` appears in the URL in the location header. In the example below, the `product-id` is **307634**.\nThere is no content in the response body.\nFor details about possible errors, see: [General Errors](doc:general-errors) and [Catalog Errors](doc:catalog-errors).\n\n<hr>\n\n##Example\n\n###Request Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X POST https://sandbox.bluesnap.com/services/2/catalog/products \\\\\\n-H 'Content-Type: application/xml' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\\n<product xmlns=\\\"http://ws.plimus.com\\\">\\n  <product-name>new product</product-name>\\n  <product-short-description>This is the product short description</product-short-description>\\n  <product-long-description>This is the product long description</product-long-description>\\n  <product-info-url>http://www.myurl.com</product-info-url>\\n  <product-merchant-descriptor>merchantname123456</product-merchant-descriptor>\\n  <product-support-email>product:::at:::newproduct.com</product-support-email>\\n  <product-image>image.jpg</product-image>\\n</product>\",\n      \"language\": \"curl\",\n      \"name\": \"Create Product Request\"\n    }\n  ]\n}\n[/block]\n###Response Example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"HTTP/ 1.1 201 Created\\nLocation: https://sandbox.bluesnap.com/services/2/catalog/products/307634\",\n      \"language\": \"http\",\n      \"name\": \"201 Created\"\n    }\n  ]\n}\n[/block]\n<hr>\n\n##Example Description\nThe example above shows a Create Product request with all of the basic product attributes, such as the name, image, description, URL, email, and descriptor.\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"create-product","type":"endpoint","title":"Create Product"}

postCreate Product


Definition

https://sandbox.bluesnap.com/services/2/catalog/products


Documentation

The Create Product request enables you to create a new product in your catalog.

Request Content

product    required, contains the following properties (see product):
      product-status string    optional
      product-name string    required
      product-short-description string    required
      product-long-description string    optional
      product-info-url decimal    optional
      product-image string    optional
      product-merchant-descriptor string    optional
      product-support-email string    optional

Response Details

If successful, the response HTTP status code is 201 Created.
The product-id appears in the URL in the location header. In the example below, the product-id is 307634.
There is no content in the response body.
For details about possible errors, see: General Errors and Catalog Errors.


Example

Request Example

curl -v -X POST https://sandbox.bluesnap.com/services/2/catalog/products \
-H 'Content-Type: application/xml' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
<product xmlns="http://ws.plimus.com">
  <product-name>new product</product-name>
  <product-short-description>This is the product short description</product-short-description>
  <product-long-description>This is the product long description</product-long-description>
  <product-info-url>http://www.myurl.com</product-info-url>
  <product-merchant-descriptor>merchantname123456</product-merchant-descriptor>
  <product-support-email>product@newproduct.com</product-support-email>
  <product-image>image.jpg</product-image>
</product>

Response Example

HTTP/ 1.1 201 Created
Location: https://sandbox.bluesnap.com/services/2/catalog/products/307634


Example Description

The example above shows a Create Product request with all of the basic product attributes, such as the name, image, description, URL, email, and descriptor.


Back to Top