Orders

Modify an existing Order.

Changed on

Only status, shipment_status, tracking_number, tracking_company, tracking_url, expected_arrival_from, expected_arrival_to, additional_information, additional_fields and customer.email can be updated. The request must include at least one of status, shipment_status, additional_information or additional_fields.

Changing shipment_status or the tracking information requires the fulfillment permission (write_orders or write_fulfillments scope for OAuth apps). Tracking information sent without shipment_status marks the shipment as delivered. Changing status emails the customer, and setting shipment_status to requested or in_transit sends the order shipped email. customer.email is only set when the Order has no email yet.

put/orders/{id}.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/orders/{id}.json
  • Auth
    • HTTP basic
    • or API key in query parameter login and API key in query parameter authtoken
    • or OAuth 2
      Authorization code: https://accounts.jumpseller.com/oauth/authorize
      Token URL: https://accounts.jumpseller.com/oauth/token scopes: write_orders

Path parameters

idinteger required

Id of the Order

Request body

Response

OK

Changes

    • info

      added the optional property / to the response with the status

    • info

      removed the volta enum value from the /// response property for the response status

    • breaking

      request property /// was restricted to a list of enum values

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property /// became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the /// response's property format changed from string to no format for status

    • breaking

      the // response's property type changed from number to string for status

    • breaking

      the // response's property type changed from number to string for status

    • breaking

      the // response's property type changed from number to string for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new Created enum value to the / response property for the response status

    • warning

      added the new Created enum value to the / response property for the response status

    • warning

      added the new billing enum value to the /// response property for the response status

    • warning

      added the new contact enum value to the /// response property for the response status

    • warning

      added the new fulfilled enum value to the / response property for the response status

    • warning

      added the new fulfilled enum value to the / response property for the response status

    • warning

      added the new in_preparation enum value to the / response property for the response status

    • warning

      added the new not_applicable enum value to the / response property for the response status

    • warning

      added the new other enum value to the /// response property for the response status

    • warning

      added the new partial enum value to the / response property for the response status

    • warning

      added the new point_pickup enum value to the / response property for the response status

    • warning

      added the new shipping enum value to the /// response property for the response status

    • warning

      added the new unfulfilled enum value to the / response property for the response status

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      the request property /// became nullable

    • info

      added the new billing enum value to the request property ///

    • info

      added the new contact enum value to the request property ///

    • info

      added the new in_preparation enum value to the request property /

    • info

      added the new other enum value to the request property ///

    • info

      added the new shipping enum value to the request property ///

    • info

      the /// request property format was generalized from string to no format

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed the Delivered enum value from the / response property for the response status

    • info

      removed the Failed enum value from the / response property for the response status

    • info

      removed the In Transit enum value from the / response property for the response status

    • info

      removed the Pickup Available enum value from the / response property for the response status

    • info

      removed the Requested enum value from the / response property for the response status

    • info

      removed the Unfulfilled enum value from the / response property for the response status