如何通过Plentymarket REST API设置订单备注？代码报错求助

Hey there, let's figure out why your order note (comment) isn't being created successfully with the Plentymarket API. I've debugged similar issues with this endpoint before, so here are the key checks and fixes to try:

1. Fix Request Headers & Payload Format #

Plentymarket's REST API expects POST payloads to be JSON-encoded, not raw arrays, and requires proper authentication headers. Chances are your _makeRequest method isn't handling this correctly.

Update your request handling to ensure:

• You're sending a Content-Type: application/json header
• Your params are converted to a JSON string
• You include a valid Bearer token for authorization

Here's how to adjust your _makeRequest method for POST requests:

private function _makeRequest($endpoint, $method = 'GET', $params = []) {
    $ch = curl_init();
    $url = 'YOUR_PLENTYMARKET_BASE_URL' . $endpoint; // Replace with your actual base URL

    $headers = [
        'Authorization: Bearer YOUR_API_ACCESS_TOKEN', // Add your valid API token here
        'Content-Type: application/json'
    ];

    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    if ($method === 'POST') {
        curl_setopt($ch, CURLOPT_POST, true);
        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params)); // Encode params to JSON format
    }

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    // Capture detailed error info for debugging
    if ($httpCode >= 400) {
        $error = json_decode($response, true) ?? $response;
        error_log("Plentymarket API Error ({$httpCode}): " . print_r($error, true));
        return ['error' => $error, 'http_code' => $httpCode];
    }

    return json_decode($response, true);
}

2. Validate Parameter Structure & Case Sensitivity #

Plentymarket's API can be case-sensitive for certain fields. Double-check these details:

• referenceType: Some API versions require this to be Order (capitalized) instead of order
• Ensure you're not missing required fields (like type—some endpoints expect this to be set to comment or order_note)

Try updating your params array to match this structure:

$params = array(
    'referenceType' => 'Order', // Verify case with your specific API version
    'referenceValue' => $orderId,
    'text' => $orderNote,
    'isVisibleForContact' => true,
    'type' => 'comment' // Add if required by your API documentation
);

3. Capture & Analyze Error Responses #

Right now, you're not seeing the full error details that Plentymarket returns. The adjusted _makeRequest method above logs HTTP status codes and error messages, which will tell you exactly what's broken:

• 401 Unauthorized: Your API token is invalid or missing
• 400 Bad Request: A parameter is missing, formatted incorrectly, or invalid
• 403 Forbidden: Your token doesn't have permission to write order comments
• 404 Not Found: The endpoint URL is incorrect (double-check /rest/comments is valid for your API version)

4. Verify Order ID & Permissions #

• Make sure $orderId is a valid, existing Plentymarket order ID (not an external reference number)
• Confirm your API token has the necessary permissions (look for orders_comments_write or similar in your Plentymarket account settings)

Final Tip #

Start by enabling the error logging in _makeRequest—the error message from the API will point you directly to the issue. More often than not, it's a missing header, incorrect JSON encoding, or a case-sensitive parameter.

内容的提问来源于stack exchange，提问作者Yogender