Skip to content

Latest commit

 

History

History
147 lines (102 loc) · 3.98 KB

OrderEditApi.md

File metadata and controls

147 lines (102 loc) · 3.98 KB
Raw

OrderEditApi

All URIs are relative to https://api.medusa-commerce.com/store

Method HTTP request Description
getOrderEditsOrderEdit GET /order-edits/{id} Retrieve an OrderEdit
postOrderEditsOrderEditComplete POST /order-edits/{id}/complete Completes an OrderEdit
postOrderEditsOrderEditDecline POST /order-edits/{id}/decline Decline an OrderEdit

getOrderEditsOrderEdit

StoreOrderEditsRes getOrderEditsOrderEdit(id)

Retrieve an OrderEdit

Retrieves a OrderEdit.

Example

// Import classes:
//import mobi.appcent.medusa.store.ApiException;
//import api.mobi.appcent.medusa.store.OrderEditApi;


OrderEditApi apiInstance = new OrderEditApi();
String id = "id_example"; // String | The ID of the OrderEdit.
try {
    StoreOrderEditsRes result = apiInstance.getOrderEditsOrderEdit(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderEditApi#getOrderEditsOrderEdit");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The ID of the OrderEdit.

Return type

StoreOrderEditsRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

postOrderEditsOrderEditComplete

StoreOrderEditsRes postOrderEditsOrderEditComplete(id)

Completes an OrderEdit

Completes an OrderEdit.

Example

// Import classes:
//import mobi.appcent.medusa.store.ApiException;
//import api.mobi.appcent.medusa.store.OrderEditApi;


OrderEditApi apiInstance = new OrderEditApi();
String id = "id_example"; // String | The ID of the Order Edit.
try {
    StoreOrderEditsRes result = apiInstance.postOrderEditsOrderEditComplete(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderEditApi#postOrderEditsOrderEditComplete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The ID of the Order Edit.

Return type

StoreOrderEditsRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

postOrderEditsOrderEditDecline

StoreOrderEditsRes postOrderEditsOrderEditDecline(id, body)

Decline an OrderEdit

Declines an OrderEdit.

Example

// Import classes:
//import mobi.appcent.medusa.store.ApiException;
//import api.mobi.appcent.medusa.store.OrderEditApi;


OrderEditApi apiInstance = new OrderEditApi();
String id = "id_example"; // String | The ID of the OrderEdit.
StorePostOrderEditsOrderEditDecline body = new StorePostOrderEditsOrderEditDecline(); // StorePostOrderEditsOrderEditDecline | 
try {
    StoreOrderEditsRes result = apiInstance.postOrderEditsOrderEditDecline(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling OrderEditApi#postOrderEditsOrderEditDecline");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The ID of the OrderEdit.
body StorePostOrderEditsOrderEditDecline [optional]

Return type

StoreOrderEditsRes

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json, text/plain