How to find valid values for fields in the REST API
I have been searching for documentation regarding the REST API. All I have found is the Swagger page. It gives a good overview but it doesn't provide any information about valid values for individual fields.
From what I have found there is no such documentation available.
How can I find out what values are valid for all different fields in the API?
Example:
For a POST to /V1/coupons (salesRuleCouponRepositoryV1), how do I find out what the valid values for "type" are and what they mean?
api rest documentation
edited 1 hour ago
Shoaib Munir
2,2991829
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
add a comment |
I have been searching for documentation regarding the REST API. All I have found is the Swagger page. It gives a good overview but it doesn't provide any information about valid values for individual fields.
From what I have found there is no such documentation available.
How can I find out what values are valid for all different fields in the API?
Example:
For a POST to /V1/coupons (salesRuleCouponRepositoryV1), how do I find out what the valid values for "type" are and what they mean?
api rest documentation
edited 1 hour ago
Shoaib Munir
2,2991829
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
hello! did you find any response to this? thanks
– mxb
Nov 28 '17 at 12:25
add a comment |
I have been searching for documentation regarding the REST API. All I have found is the Swagger page. It gives a good overview but it doesn't provide any information about valid values for individual fields.
From what I have found there is no such documentation available.
How can I find out what values are valid for all different fields in the API?
Example:
For a POST to /V1/coupons (salesRuleCouponRepositoryV1), how do I find out what the valid values for "type" are and what they mean?
api rest documentation
edited 1 hour ago
Shoaib Munir
2,2991829
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
I have been searching for documentation regarding the REST API. All I have found is the Swagger page. It gives a good overview but it doesn't provide any information about valid values for individual fields.
From what I have found there is no such documentation available.
How can I find out what values are valid for all different fields in the API?
Example:
For a POST to /V1/coupons (salesRuleCouponRepositoryV1), how do I find out what the valid values for "type" are and what they mean?
api rest documentation
api rest documentation
edited 1 hour ago
Shoaib Munir
2,2991829
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
edited 1 hour ago
Shoaib Munir
2,2991829
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
edited 1 hour ago
Shoaib Munir
2,2991829
edited 1 hour ago
Shoaib Munir
2,2991829
edited 1 hour ago
Shoaib Munir
2,2991829
2,2991829
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
asked Aug 16 '17 at 12:34
Björn JanssonBjörn Jansson
1
1
hello! did you find any response to this? thanks
– mxb
Nov 28 '17 at 12:25
add a comment |
hello! did you find any response to this? thanks
– mxb
Nov 28 '17 at 12:25
hello! did you find any response to this? thanks
– mxb
Nov 28 '17 at 12:25
hello! did you find any response to this? thanks
– mxb
Nov 28 '17 at 12:25
add a comment |
1 Answer
1
active
oldest
votes
You can get it from here
REST APIs
You can check salesRuleCouponRepositoryV1 all actions and valid values from here.
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
Thanks. I have seen the Swagger page as I wrote in my question. But what I can't find is the valid values for each field. If i look at "POST salesRuleCouponRepositoryV1" it says that the field "type" is a numeric field. But how do I know what values are valid? Is it 1, 67 or 39774? And what do each number mean?
– Björn
Aug 17 '17 at 6:54
Have you study post example from given example?
– Suresh Chikani
Aug 17 '17 at 6:56
Yes, I have. I can't find any information about each individual field, more than the data type.
– Björn
Aug 17 '17 at 7:39
add a comment |
Your Answer
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "479"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fmagento.stackexchange.com%2fquestions%2f189322%2fhow-to-find-valid-values-for-fields-in-the-rest-api%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
You can get it from here
REST APIs
You can check salesRuleCouponRepositoryV1 all actions and valid values from here.
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
Thanks. I have seen the Swagger page as I wrote in my question. But what I can't find is the valid values for each field. If i look at "POST salesRuleCouponRepositoryV1" it says that the field "type" is a numeric field. But how do I know what values are valid? Is it 1, 67 or 39774? And what do each number mean?
– Björn
Aug 17 '17 at 6:54
Have you study post example from given example?
– Suresh Chikani
Aug 17 '17 at 6:56
Yes, I have. I can't find any information about each individual field, more than the data type.
– Björn
Aug 17 '17 at 7:39
add a comment |
You can get it from here
REST APIs
You can check salesRuleCouponRepositoryV1 all actions and valid values from here.
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
Thanks. I have seen the Swagger page as I wrote in my question. But what I can't find is the valid values for each field. If i look at "POST salesRuleCouponRepositoryV1" it says that the field "type" is a numeric field. But how do I know what values are valid? Is it 1, 67 or 39774? And what do each number mean?
– Björn
Aug 17 '17 at 6:54
Have you study post example from given example?
– Suresh Chikani
Aug 17 '17 at 6:56
Yes, I have. I can't find any information about each individual field, more than the data type.
– Björn
Aug 17 '17 at 7:39
add a comment |
You can get it from here
REST APIs
You can check salesRuleCouponRepositoryV1 all actions and valid values from here.
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
You can get it from here
REST APIs
You can check salesRuleCouponRepositoryV1 all actions and valid values from here.
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
edited Aug 17 '17 at 6:42
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
answered Aug 17 '17 at 6:36
Suresh ChikaniSuresh Chikani
10.4k53371
10.4k53371
Thanks. I have seen the Swagger page as I wrote in my question. But what I can't find is the valid values for each field. If i look at "POST salesRuleCouponRepositoryV1" it says that the field "type" is a numeric field. But how do I know what values are valid? Is it 1, 67 or 39774? And what do each number mean?
– Björn
Aug 17 '17 at 6:54
Have you study post example from given example?
– Suresh Chikani
Aug 17 '17 at 6:56
Yes, I have. I can't find any information about each individual field, more than the data type.
– Björn
Aug 17 '17 at 7:39
add a comment |
Thanks. I have seen the Swagger page as I wrote in my question. But what I can't find is the valid values for each field. If i look at "POST salesRuleCouponRepositoryV1" it says that the field "type" is a numeric field. But how do I know what values are valid? Is it 1, 67 or 39774? And what do each number mean?
– Björn
Aug 17 '17 at 6:54
Have you study post example from given example?
– Suresh Chikani
Aug 17 '17 at 6:56
Yes, I have. I can't find any information about each individual field, more than the data type.
– Björn
Aug 17 '17 at 7:39
Thanks. I have seen the Swagger page as I wrote in my question. But what I can't find is the valid values for each field. If i look at "POST salesRuleCouponRepositoryV1" it says that the field "type" is a numeric field. But how do I know what values are valid? Is it 1, 67 or 39774? And what do each number mean?
– Björn
Aug 17 '17 at 6:54
Thanks. I have seen the Swagger page as I wrote in my question. But what I can't find is the valid values for each field. If i look at "POST salesRuleCouponRepositoryV1" it says that the field "type" is a numeric field. But how do I know what values are valid? Is it 1, 67 or 39774? And what do each number mean?
– Björn
Aug 17 '17 at 6:54
Have you study post example from given example?
– Suresh Chikani
Aug 17 '17 at 6:56
Have you study post example from given example?
– Suresh Chikani
Aug 17 '17 at 6:56
Yes, I have. I can't find any information about each individual field, more than the data type.
– Björn
Aug 17 '17 at 7:39
Yes, I have. I can't find any information about each individual field, more than the data type.
– Björn
Aug 17 '17 at 7:39
add a comment |
Thanks for contributing an answer to Magento Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fmagento.stackexchange.com%2fquestions%2f189322%2fhow-to-find-valid-values-for-fields-in-the-rest-api%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
hello! did you find any response to this? thanks
– mxb
Nov 28 '17 at 12:25